API get reports aggrbycreative pub
From Wiki
Contents |
GET reports aggregated by creative (for publishers)
The creative performance report aggregates transactions, clicks and impressions for the creatives a publisher uses.
Who can use it
publishers
How to call it
Add the parameter 'accessToken' to provide your access key as described in API authentication and authorization.
parameter | format | mandatory/optional |
startDate | yyyy-MM-dd | mandatory |
endDate | yyyy-MM-dd | mandatory |
dateType | transaction validation | optional (falls back to "transaction" if not set) |
region |
currently supported: | mandatory |
timezone |
America/Sao_Paulo | mandatory |
How the response looks
[ { "advertiserId": 1001, "advertiserName": "Example Advertiser", "publisherId": 45628, "publisherName": "Example Publisher", "region": "GB", "currency": "GBP", "impressions": 0, "clicks": 0, "creativeId": 12345, "creativeName": "Example creative static 360x600", "tagName": "christmas", "pendingNo": 0, "pendingValue": 0, "pendingComm": 0, "confirmedNo": 0, "confirmedValue": 0, "confirmedComm": 0, "bonusNo": 1, "bonusValue": 0, "bonusComm": 2500, "totalNo": 1, "totalValue": 0, "totalComm": 2500, "declinedNo": 0, "declinedValue": 0, "declinedComm": 0 }, (...)
Which datafields do we provide
field name | description |
advertiserId | |
advertiserName | |
publisherId | |
publisherName | |
region | |
currency | ISO code |
impressions | number of impressions |
clicks | number of clicks |
creativeId | id of the creative |
creativeName | name of the creative |
tagName | tag name of the creative, used by the advertiser to group creatives |
pendingNo | number of pending transactions |
pendingValue | value of the pending transactions |
pendingComm | commissions of the pending transactions |
confirmedNo | number of confirmed transactions |
confirmedValue | value of confirmed transactions |
confirmedComm | commission of the confirmed transactions |
bonusNo | number of bonus transactions |
bonusValue | value of the bonus transactions |
bonusComm | commission of the bonus transactions |
totalNo | total number of transactions |
totalValue | value of all transactions |
totalComm | commission of all transactions |
declinedNo | number of declined transactions |
declinedValue | value of declined transactions |
declinedComm | commission of declined transactions |