Updated: Oct 8th, 2019
The page explains how an advertiser may use the Adomni API to review plays and impressions for a campaign.
We will assume that you already has an advertiser account and you are able to authenticate. We also assume the user has already created an campaign and that the campaign has plays against it.
To get individual play records:
GET https://neon.adomni.com/v1/reports/plays?type=order&orderId={ORDER-ID}&detailLevel=row
Example Response:
{
"results": [
{
"orderId": 19468,
"timestamp": 1569738100000,
"deviceId": 118718,
"networkId": 118637,
"contentId": 99921,
"userId": 855,
"lineItemId": 42655,
"adPlays": 1,
"impressions": 0.98,
"location": {
"lng": "153.35060000",
"lat": "-27.86720000",
"timestamp": 1569738035493
},
"date": "2019-09-29"
},
{
"orderId": 19468,
"timestamp": 1569738100000,
"deviceId": 118675,
"networkId": 118637,
"contentId": 99921,
"userId": 855,
"lineItemId": 42655,
"adPlays": 1,
"impressions": 3.99,
"location": {
"lng": "153.43410900",
"lat": "-28.04233600",
"timestamp": 1569738037250
},
"date": "2019-09-29"
}]
}
By default, this will return the last 24hrs of plays. If you'd like to specify a time range, add the startEpoch
and endEpoch
. See the full list of parameters for /reports/plays
in our API browser.
There are three detail levels available: row
(individual plays per above), content
and summary
. You can specify the desired output in the detailLevel
parameter.