v1

latestOpenAPI 3.0.12026-07-2210997354.2 KB

Analytics

Contents analytics

Retrieves an analytics overview for all content items in a project

get/projects/{project_id}/content/analytics

Query parameters

media_variants[]string[]

The media variants to fetch data for

media_formats[]string[]

The media formats to fetch data for

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]'player_impressions' | 'listens' | 'listen_rate' | 'avg_listen_time' | 'avg_listen_duration'

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

order[dir]'asc' | 'desc'

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

access_tiers[]string[]

The access tiers to fetch data for

filter[title]string

Get analytics for content whose title contains the specified string. Note: filter[title] does not work in combination with order[by]

filter[player_impressions][to]integer

filter[player_impressions][from]integer

filter[listens][to]integer

filter[listens][from]integer

filter[listen_rate][to]integer

filter[listen_rate][from]integer

filter[avg_listen_time][to]integer

filter[avg_listen_time][from]integer

filter[avg_listen_duration][to]integer

filter[avg_listen_duration][from]integer

Response

idstring nullable

Content identifier

source_idstring

Externally provided content identifier

source_urlstring uri nullable

URL of the source content

image_urlstring uri nullable

Content image URL

titlestring nullable

Content title

player_impressionsinteger

Number of player loads (audio or video)

listensinteger

Number of play sessions (audio or video)

listen_ratenumber

Proportion of impressions that resulted in a play (0.0–1.0)

avg_listen_timeinteger

Average play time per session in seconds (audio or video). This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.

avg_listen_durationnumber

Average percentage of the item consumed (0-100). This metric may be understated when play progress is stored as every 10% milestone event per session instead of only a final event.

publishedstring date-time nullable

Time at which the content was published (ISO 8601)