/stats
This endpoint is for getting a list of selected items and the stats associated with them.
Example GET request
Parameter | Scope | Value | Function |
---|---|---|---|
context | required | String | Network to get information from |
auth_token | required | String | Authorization |
startDate | required | Date in UTC (2020-01-01T23:00:00:00.000Z) | Start date of the report |
endDate | required | Date in UTC (2020-01-01T23:00:00:00.000Z) | End date of the report |
all | optional | lineItem, order, creative, advertiser | Selects the endpoint for which to get the data. |
groupBy | optional | ORDER, LINE_ITEM, ADVERTISER | Defines how to group the "chunks" |
includeAll | optional | Boolean | Weather or not to show items that has 0 impressions. |
includeChunkRange | optional | boolean | Includes all the dates even if there are no stats on those dates |
aggregateTo | optional | ORDER, LINE_ITEM, ADVERTISER | Determine what chunks should be in the response. |
Example request
Example Response
Key | Value | Description |
---|---|---|
chunks | Array | An array of the data for the selected scope. |
totals | Object | The aggregated totals for selected scope. |
ctr | Percentage | Click through rate |
viewability | Percentage | The percentage of impressions being more than one second in screen. |
cost | Number | the total cost of the scope between selected dates. |
visibility | Percentage | Percentage of impressions that has been in screen. |
viewables | Number | Number of impressions that have been in screen. |
lineItem | Object | The Object containing line item information. |
averageAuctionRank | Number | The average auction rank of the selected scope. (The average placement if ad unit can hold more than one ad.) |
impressionsPerUniqueUser | Number | Number of impressions a unique user makes. |
impressions | Number | Total amount of impressions |
visibles | Number | Number of impressions that has been in screen. |
rendered | Number | Number of impressions rendered in the browser. |
eCpm | Number | Effective cost per thousand impressions. |
currency | String | Currency |
amount | Number | Amount of cost |
uniqueUsers | Number | Number of users that have seen the ad. |
clicks | Number | The number of clicks on the ad. |
Last updated