Get
/publishers/{publisherId}/commissiongroups
GET commissiongroups
Publishers can request all commission groups of a programme, together with the commission values they get. Furthermore, it is possible to just pull the commission value for a single commission group.
Who can use it
Publishers that have an active relationship with a programme
Header parameters
Authorization
string
accessToken
Path parameters
publisherId
integer (int64) Required
publisherId
Query parameters
accessToken
stringRequired
access token
advertiserId
integer (int64) Required
advertiserId
effectiveDate
string (date-time)
ISO-8601 date (e.g 2025-03-15T23:59:59Z) to get the commission groups for. If omitted, defaults to now, i.e. the active commission groups
Responses
200
OK
object
advertiser
integer (int64)
commissionGroups
Array of object (CommissionGroup)
object
amount
number
currency
string
groupCode
string
groupId
integer (int64)
groupName
string
percentage
number
type
string
publisher
integer (int64)
ratesEnd
string (date-time)
Exampleyyyy-MM-dd'T'HH:mm:ss'Z'
ratesStart
string (date-time)
Exampleyyyy-MM-dd'T'HH:mm:ss'Z'
Which data fields do we provide
| field name | description |
| groupId | the ID of the commission groups, it is unique even across advertisers |
| groupCode | code of the commission group, not necessarily unique across advertisers |
| groupName | name of the commission group, can provide additional information to the groupCode |
| type | can be either "fix" or "percentage" |
| amount | only available for type "fix" |
| currency | only available for type "fix" |
| percentage | only available for type "percentage" |
| ratesStart | ISO-8601 timestamp indicating when this set of rates becomes effective |
| ratesEnd | ISO-8601 timestamp indicating when this set of rates stops being effective. This field is omitted if the rates are ongoing |