API get commissiongroups

From Wiki

(Difference between revisions)
Jump to: navigation, search
Alex Allan (Talk | contribs)
Florian Geldner (Talk | contribs)
 
Line 10: Line 10:
https://api.awin.com/publishers/45628/commissiongroups?advertiserId=1001 (for all commission groups of a certain advertiser)<br>
https://api.awin.com/publishers/45628/commissiongroups?advertiserId=1001 (for all commission groups of a certain advertiser)<br>
-
https://api.awin.com/publishers/45628/commissiongroups/19474 (for a specific commission group of an advertiser; as the group ID is unique, no advertiser ID has to be provided)
 
Add the parameter 'accessToken' to provide your access key as described in  [[API_authentication|API authentication and authorization]].
Add the parameter 'accessToken' to provide your access key as described in  [[API_authentication|API authentication and authorization]].
Line 47: Line 46:
-
For a specific commission group<br>
 
-
<div style="overflow:auto; padding: 4px .2em; word-spacing: 4px; border: 1px dashed #2F6FAB; background:#F9F9F9">
 
-
<source lang="javascript">
 
-
 
-
{
 
-
  "advertiser": 1001,
 
-
  "publisher": 45628,
 
-
  "commissionGroups": [
 
-
    {
 
-
      "groupId": 19474,
 
-
      "groupCode": "JS",
 
-
      "groupName": "Julius's's",
 
-
      "type": "fix",
 
-
      "amount": 100,
 
-
      "currency": "GBP"
 
-
    }
 
-
  ]
 
-
}
 
-
 
-
</source>
 
-
</div>
 

Current revision as of 13:49, 17 June 2019

Contents

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

How to call it

https://api.awin.com/publishers/45628/commissiongroups?advertiserId=1001 (for all commission groups of a certain advertiser)

Add the parameter 'accessToken' to provide your access key as described in API authentication and authorization.


How the response looks

For all commission groups of an advertiser

{
  "advertiser": 1001,
  "publisher": 45628,
  "commissionGroups": [
    {
      "groupId": 147,
      "groupCode": "GP1",
      "groupName": "group 1",
      "type": "percentage",
      "percentage": 2
    },
 
    {
      "groupId": 19474,
      "groupCode": "JS",
      "groupName": "Julius's's",
      "type": "fix",
      "amount": 100,
      "currency": "GBP"
    },
 
()



Which datafields 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"

Privacy

Due to new European legislation regarding how websites store information about you, AWIN is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button