List Engagement Data

This endpoint will return video engagement data for your property.

Log in to see full request history
Query Params
string

Filter records created after the specified start_date (filters[start_date_gte]=2018-11-01). If no start_date is specified, then data returned will date back two weeks ago.

string

Filter records created on or after the specified start_date.

string

Filter records created before the specified start_date.

string

Filter records created on or before the specified start_date.

string

Filter records created on the specified start_date. Comparison is date and time specific. If no time values are submitted, 00:00:00 UTC is assumed.

string

Filter records where time_watched_hours is equal to the specified value.

string

Filter records where time_watched_hours is greater than the specified value.

string

Filter records where time_watched_hours is greater than or equal to the specified value.

string

Filter records where time_watched_hours is less than the specified value.

string

Filter records where time_watched_hours is less than or equal to the specified value.

string

Filter records where time_watched_minutes is equal to the specified value.

string

Filter records where time_watched_minutes is greater than the specified value.

string

Filter records where time_watched_minutes is greater than or equal to the specified value.

string

Filter records where time_watched_minutes is less than the specified value.

string

Filter records where time_watched_minutes is less than or equal to the specified value.

string

Filter records where time_watched_seconds is equal to the specified value.

string

Filter records where time_watched_seconds is greater than the specified value.

string

Filter records where time_watched_seconds is greater than or equal to the specified value.

string

Filter records where time_watched_seconds is less than the specified value.

string

Filter records where time_watched_seconds is less than or equal to the specified value.

string

Filter records where avg_play_length_hours is equal to the specified value.

string

Filter records where avg_play_length_hours is greater than the specified value.

string

Filter records where avg_play_length_hours is greater than or equal to the specified value.

string

Filter records where avg_play_length_hours is less than the specified value.

string

Filter records where avg_play_length_hours is less than or equal to the specified value.

string

Filter records where avg_play_length_minutes is equal to the specified value.

string

Filter records where avg_play_length_minutes is greater than the specified value.

string

Filter records where avg_play_length_minutes is greater than or equal to the specified value.

string

Filter records where avg_play_length_minutes is less than the specified value.

string

Filter records where avg_play_length_minutes is less than or equal to the specified value.

string

Filter records where avg_play_length_seconds is equal to the specified value.

string

Filter records where avg_play_length_seconds is greater than the specified value.

string

Filter records where avg_play_length_seconds is greater than or equal to the specified value.

string

Filter records where avg_play_length_seconds is less than the specified value.

string

Filter records where avg_play_length_seconds is less than or equal to the specified value.

string

Filter records where plays is equal to the specified value.

string

Filter records where plays is greater than the specified value.

string

Filter records where plays is greater than or equal to the specified value.

string

Filter records where plays is less than the specified value.

string

Filter records where plays is less than or equal to the specified value.

string

Filter records by video_id

string

Filter records by video_title

string

Filter records by consumer_id

string | null

Shortcut method to group records by time intervals. Accepted values: day.

sums
array of strings or null

For each numeric property, return a sum of that property for each time interval. Accepted properties: time_watched_hours, time_watched_minutes, time_watched_seconds, avg_play_length_hours, avg_play_length_minutes, avg_play_length_seconds, plays

sums
group_by
array of strings or null

Group records by one or more properties of the data returned -- accepted values are: start_date, plays, video_title, video_id, consumer_id, avg_play_length_seconds, avg_play_length_minutes, avg_play_length_hours, time_watched_seconds, time_watched_minutes, time_watched_hours

group_by
string

Sort results by value of a specific property + '_' + sort direction (Example - sort_by=start_date_asc, or sort_by=video_id_desc)

integer

Limit the number of records returned

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json