Contents
Get programmes
Who can use it?
How to call it
How the response looks
Which datafields do we provide?
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
GET programmes
Publishers can check automatically with which programmes they currently have an active relationship. They can also check the whole program list, and filter by program region/country.
Who can use it?
Publishers. Please note: need to at least have "viewer" access to the account.
How to call it
https://api.awin.com/publishers/45628/programmes (lists all active and visible programmes)
https://api.awin.com/publishers/45628/programmes?relationship=joined (lists all active and visible programmes that the publisher account has an active relationship with, possible values are joined, pending, suspended, rejected, not joined)
https://api.awin.com/publishers/45628/programmes?countryCode=IE (lists all active and visible programmes from a certain country, defined by the country code)
https://api.awin.com/publishers/45628/programmes?includeHidden=true returns all of the active and also hidden programmes the publisher is joined to
Add the parameter 'accessToken' to provide your access key as described in How do I generate my Publisher API access token?
How the response looks
[
{
"description": "Awin programme description.",
"id": 3,
"name": "Affiliate Window",
"displayUrl": "http://www.affiliatewindow.com",
"clickThroughUrl": "http://www.awin1.com/awclick.php?mid=3&id=267235",
"logoUrl": "http://www.affiliatewindow.com/logos/3/logo.gif",
"primaryRegion": {
"name": "United Kingdom",
"countryCode": "GB"
}
"currencyCode": "GBP"
"status": "Active",
"validDomains": [
{
"domain": "www.awin1.com"
},
{
"domain": "www.awin2.com"
}
]
},
{
"description": "Swerve programme description.",
"id": 4,
"name": "Swerve",
"displayUrl": ": "http://www.swerve.co.uk",
"clickThroughUrl": "http://www.awin1.com/awclick.php?mid=4&id=267235",
"logoUrl": "http://www.affiliatewindow.com/logos/4/logo.gif",
"primaryRegion": {
"name": "United Kingdom",
"countryCode": "GB"
}
"currencyCode": "GBP",
"status": "Active",
"validDomains": [
{
"domain": "www.swerve.com"
},
{
"domain": "www.swerve1.com"
}
]
},
(…)
Which datafields do we provide?
| Field Name | Description |
|---|
| ID | ID of the programme |
| name | name of the programme |
| displayUrl | URL of the advertiser |
| clickThroughUrl | |
| logoUrl | URL to the logo of the programme |
| primaryRegion | object that contains the name and the countryCode of the primary programme region |
| 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 |
