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
http://api.brand.display.io/api/advertiserAPI
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=oxJrn1mgEyx89Js1xp8m3xM5g019-02-15%20day&timerangefrom=2019-02-01%2008%3A00%3A00&timerangeto=2019-02-15%2008%3A00%3A0019-02-15%200
http://api.brand.display.io/api/advertiserAPI?method=getReport&key=oxJrn1mgEyx89Js1xp8m3xM5g019-02-15%20day&timerangefrom=2019-02-01%2008%3A00%3A00&timerangeto=2019-02-15%2008%3A00%3A0019-02-15%200
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-05 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%"
}
},
"status": "success",
"data": {
"sums": {
"clicks": 403,
"imps": 4803,
"revenue": "$14.15",
"ecpm": "$2.95",
"ctr": "8.39%",
"fill": "88.20%"
}
}
}
