Get program information for publisher by relationship and optionally filter by country
- 04 Jul 2024
- DarkLight
Get program information for publisher by relationship and optionally filter by country
- Updated on 04 Jul 2024
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/publishers/{publisherId}/programmes
GET programmes
Publishers can check programmatically, with which programmes they currently have an active, pending, suspended, rejected or not joined relationship. They can also check the whole program list, and filter by program region/country.
Who can use it?
Publishers
Header parameters
Authorization
string
accessToken
Path parameters
publisherId
stringRequired
publisher id
Query parameters
accessToken
stringRequired
access token
countryCode
string
country code has to be ISO Alpha-2, i.e. GB, DE, FR, ...
includeHidden
boolean
Only works when no relationship is specified
relationship
string
relationship
Valid values[ "\"joined\"", "\"pending\"", "\"suspended\"", "\"rejected\"", "\"notjoined\"" ]
Responses
200
OK
Array of object
object
clickThroughUrl
string
currencyCode
string
description
string
displayUrl
string
id
integer (int64)
logoUrl
string
name
string
primaryRegion
object (PrimaryRegion)
countryCode
string
name
string
primarySector
string
status
string
validDomains
Array of object (Domain)
object
domain
string
Which data fields do we provide?
| field name | description |
| description | advertiser programme description |
| displayUrl | programme display URL |
| logoUrl | URL to the logo of the programme |
| clickThroughUrl | programme click-through URL |
| id | advertiser programme ID |
| name | programme name |
| currencyCode | ISO code of the currency of the programme |
| primaryRegion | programme primary region |
| status | programme status. Can be active or hidden |
| validDomains | list of the programme valid domains |
Was this article helpful?