Skip to main content
GET
Ads analytics

Authorizations

X-Api-Key
string
header
required

Path Parameters

project_id
string
required

The numeric ID of your project

Query Parameters

metrics[]
string[]

The metrics that you want to fetch data for

media_variants[]
enum<string>[]

The media variants to fetch data for

Available options:
article,
summary
media_formats[]
enum<string>[]

The media formats to fetch data for

Available options:
audio,
video
time_range[start]
string

The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601.

time_range[end]
string

The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. If this is set to today, the current day is still in progress and therefore only partial analytics data is returned until the day ends.

pagination[limit]
integer

'limit' sets the number of results to return in each page.

pagination[offset]
integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

order[by]
enum<string>

This is used to order analytics by number of listens or average listen time or average listen duration

Available options:
listens
order[dir]
enum<string>

This is used to order analytics in the ascending or descending order

Available options:
asc,
desc
access_tiers[]
string[]

The access tiers to fetch data for

filter[title]
string
filter[ids][]
integer[]

Response

200 - application/json

OK

id
integer

Ad identifier

title
integer

Ad title (internal identifier)

player_impressions
object
listens
object
completions
object
completion_rate
object
clicks
object
click_rate
object