Skip to main content

Simple Metadata API

Versions:

version 1: available since 2.0.41

version 1.1: available since 2.0.43

 

If multiple implementations are available, use the header "api-version" to specify a specific version.

If no api-version header is sent, the default version 1.1 is used

If the requested version is not available, a 501 status code is returned

 

Publishers:

/api/publishers

first available in version 1

requires Admin role

returns a list of publishers in JSON format with the following fields:

  • id
  • parentId
  • companyName
  • active
  • quote

 

Publications:

/api/publications

first available in version 1

requires Admin role

returns a list of publications in JSON format with the following fields:

  • id
  • publisherId
  • name

 

Locations:

/api/locations

requires Admin role

first available in version 1

returns a list of locations in JSON format with the following fields:

  • id
  • publicationId
  • channelLevel
  • name
  • url

 

Positions:

/api/positions

requires Admin role

first available in version 1.1

available parameters:

  • boolean channelsOnly : if true, only return channels
  • boolean activeOnly : if true only return active positions for active publications
  • boolean enrichChannels: if true, also return the component position IDs for channels

e.g. /api/positions?channelsOnly=true&enrichChannels=true

returns a list of positions in JSON format with the following fields:

  • id
  • name
  • url
  • active
  • locationId
  • formatId
    optional fields:
  • componentIds (if enrichChannels is true)

 

Formats:

/api/formats

requires Admin role

first available in version 1.1

returns the list of currently used positions in JSON format with the following fields:

  • id
  • name

 

Experimental in 2.1.3

 

POST /api/campaigns/search

requires Admin role

requires headers

accept: application/json

Content-Type: application/json

first available in version 1.1

search fields:

  • campaignIds: limit the results to campaigns with one of these IDs

  • reservationTypes: the campaigns returned have at least one of the specified reservation types

  • expiration: the offer or option expires during the specified time interval

  • online: at least one booking was or will be online during the specified time interval

  • empty: if true, only return campaigns without bookings, if false, only return campaigns with at least one booking
  • key: search on campaign external key

examples:

{"empty":"false", "online":{"start":1619677000000, "end":1619678000000}}
{"reservationTypes":["option"], "expiration":{"start":1619677000000, "end":1619678000000}}
{"key":"leetcampaign"}
{"campaignIds":[19,20]}

returns a list of positions in JSON format with the following fields:

  • id
  • name
  • description
  • reservationType
  • invoiceTypeId
  • publisherId
  • expiryDate
  • externalKey

 

 

Back to top