Sign in

v1

latestOpenAPI 3.0.12026-07-2210997354.2 KB
Analytics

Projects analytics

Retrieves an analytics overview for all projects within an organization

get/projects/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]'listens' | '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

Response

OK

idstring

Project identifier

titlestring

Project title

listensinteger

Total number of plays (audio or video)

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.

createdstring date-time

Time at which the project was created (ISO 8601)