ADNUNTIUS
Search…
/stats
This endpoint is for getting a list of selected items and the stats associated with them.

Example GET request

1
https://api.adnuntius.com/api/v1/stats/
2
?context=<networkId>
3
&advObjectLabel=
4
&auth_token=f92LGtCLx1TA6vrLQ6UfaDz_5w_P...
5
&startDate=2020-02-02T23:00:00.000Z
6
&endDate=2020-02-10T14:00:00.000Z
7
&all=lineItem
8
&groupBy=LINE_ITEM
9
&includeAll=false
10
&includeChunkRange=true
11
&aggregateTo=ORDER
Copied!
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

1
/stats
2
?auth_token=PDXS2YodiUqV0ur...
3
&aggregateTo=LINE_ITEM
4
&all=lineItem
5
&context=<networkId>
6
&endDate=2021-07-15T22:00:00.000Z
7
&startDate=2021-07-14T22:00:00.000Z
8
&groupBy=ORDER
9
&includeChunkRange=true
10
&includeAll=true
Copied!

Example Response

1
{
2
"chunks": [
3
{
4
"order": {
5
"id": "lkvk7qf1y9y...",
6
"name": "Testorder",
7
"labels": [
8
"car"
9
],
10
"source": "DIRECT",
11
"url": "/api/v1/orders/lkvk7qf1y9y..."
12
},
13
"chunks": [
14
{
15
"ctr": 0.0,
16
"viewability": 0.0,
17
"cost": {
18
"currency": "NOK",
19
"amount": 0
20
},
21
"visibility": 0.0,
22
"viewables": 0,
23
"lineItem": {
24
"id": "8z6bvgphm...",
25
"name": "TestLineitem1",
26
"labels": [],
27
"source": "DIRECT",
28
"url": "/api/v1/lineitems/8z6bvgphm..."
29
},
30
"averageAuctionRank": 0.0,
31
"impressionsPerUniqueUser": 0.0,
32
"impressions": 0,
33
"visibles": 0,
34
"rendered": 0,
35
"eCpm": {
36
"currency": "NOK",
37
"amount": 0
38
},
39
"uniqueUsers": 0,
40
"clicks": 0
41
}
42
],
43
"totals": {
44
"ctr": 0.0,
45
"viewability": 0.0,
46
"cost": {
47
"currency": "NOK",
48
"amount": 0
49
},
50
"visibility": 0.0,
51
"viewables": 0,
52
"averageAuctionRank": 0.0,
53
"impressionsPerUniqueUser": 0.0,
54
"impressions": 0,
55
"visibles": 0,
56
"rendered": 0,
57
"eCpm": {
58
"currency": "NOK",
59
"amount": 0
60
},
61
"uniqueUsers": 0,
62
"clicks": 0
63
}
64
}
65
]
66
}
Copied!
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 modified 3mo ago