API get reports aggrbypub
From Wiki
Contents |
GET reports aggregated by publisher (for advertisers)
The publisher performance report aggregates transactions, clicks and impressions for all publishers an advertiser works with. If publisher has no activity (clicks, transactions,..) at all for the selected time frame, it will not be listed in the report.
Who can use it
Users who have advertiser accounts linked to their user account
Authentication
You need to provide a valid token. Please see our page about authentication and authorization.
How to call it
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) |
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, "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 "tags": [ "example_tag1", "example_tag2" ] }, (...)
Which datafields do we provide
field name | description |
advertiserId | |
advertiserName | |
publisherId | |
publisherName | |
region | |
currency | ISO code |
impressions | number of impressions |
clicks | number of clicks |
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 |
tags | publisher tags |