In order to use the reporting API resource please request a Private Key from your point of contact at display.io.
API Structure
To call the Advertiser API you will need to initiate GET requests including your API key, the API method name and it’s parameters. The API response is a json structure containing a status field indicating the success or failure of the API call and a data field containing the response payload.
Endpoint URL
API Methods
getReport
The getReport method gives to advertisers access to query their performance report, filtered by a set of time range options. It also let’s advertisers group their report by a variety of dimensions. The metrics returned from this method include: clicks, imps (impressions), revenue, ecpm, ctr and fill.
Example API Request URL
http://api.brand.display.io/api/advertiserAPI?method=getReport&key=GbASAcKE8zMWpkhTOlrGjLzJ1aShWMhOih3pGCjkZxTm4qO1RDlW&dimensions=day&timeperiod=This%20Month&timezone=America/New_York
Request Parameters
Param | Options | Example | Is Mandatory? |
---|---|---|---|
dimensions | placement, placementId, app, appId, day, hour, month, country, countryCode | dimensions=placement,day | Yes |
timeperiod | Today, Yesterday, ThisWeek, Last Week,ThisMonth, Last Month,ThisYear | timeperiod=Last%20Month | Either timeperiod or timerange values |
timerangefrom | “2018-01-05 08:00:00” | timerangefrom=2018-01-05%2008%3A00%3A00 | |
timerangeto | “2018-01-06 08:00:00” | timerangeto=2018-01-06%2008%3A00%3A00 | |
timezone | UTC, EST, Asia/Beijing (all options are available here) |
timezone=UTC | No |
If timezone parameter was not passed - server will get timezone of it's current location
Response Structure
Field | Type | Description |
---|---|---|
resNumRows | int | Number of results in the rows field |
sums | object | List of metric values for the queried time range |
rows | array | The resulted rows grouped as requested in the dimensions parameter |
Example Response
{ "status": "success", "data": { "sums": { "clicks": 403, "imps": 4803, "revenue": "$14.15", "ecpm": "$2.95", "ctr": "8.39%", "fill": "88.20%" }, "resNumRows": 7, "rows": [ { "clicks": 30, "imps": 459, "revenue": "$0.00", "ecpm": "$0.00", "ctr": "6.54%", "fill": "86.17%", "placement": "Interstitial Ad 1", "app": "My Special App", "appId": 3635, "day": "2016-11-07" }, { "clicks": 55, "imps": 653, "revenue": "$0.00", "ecpm": "$0.00", "ctr": "8.42%", "fill": "87.75%", "placement": "Interstitial Ad 1", "app": "My Special App", "appId": 3635, "day": "2016-11-06" }, { "clicks": 72, "imps": 657, "revenue": "$7.00", "ecpm": "$10.65", "ctr": "10.96%", "fill": "87.15%", "placement": "Interstitial Ad 1", "app": "My Special App", "appId": 3635, "day": "2016-11-05" }, { "clicks": 55, "imps": 615, "revenue": "$0.00", "ecpm": "$0.00", "ctr": "8.94%", "fill": "83.69%", "placement": "Interstitial Ad 1", "app": "My Special App", "appId": 3635, "day": "2016-11-04" }, { "clicks": 60, "imps": 745, "revenue": "$3.50", "ecpm": "$4.70", "ctr": "8.05%", "fill": "86.49%", "placement": "Interstitial Ad 1", "app": "My Special App", "appId": 3635, "day": "2016-11-03" }, { "clicks": 63, "imps": 780, "revenue": "$3.50", "ecpm": "$4.49", "ctr": "8.08%", "fill": "87.99%", "placement": "Interstitial Ad 1", "app": "My Special App", "appId": 3635, "day": "2016-11-02" }, { "clicks": 68, "imps": 894, "revenue": "$0.15", "ecpm": "$0.17", "ctr": "7.61%", "fill": "96.03%", "placement": "Interstitial Ad 1", "app": "My Special App", "appId": 3635, "day": "2016-11-01" } ] } , "warnings": [] }
Comments
0 comments
Please sign in to leave a comment.