Contents analytics

get

https://api.beyondwords.io/v1/projects/{project_id}/content/analytics

Retrieves an analytics overview for all content items in a project

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

string

required

The numeric ID of your project

Query Params

media_variants[]

array of strings

The media variants to fetch data for

media_variants[]

Allowed:

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.

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]

string

enum

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

Allowed:

order[dir]

string

enum

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

Allowed:

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

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK