List Engagement Data

get https://analytics.zype.com/v2/engagement

This endpoint will return video engagement data for your property.

Query Params

filters[start_date_gt]

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.

filters[start_date_gte]

string

Filter records created on or after the specified start_date.

filters[start_date_lt]

string

Filter records created before the specified start_date.

filters[start_date_lte]

string

Filter records created on or before the specified start_date.

filters[start_date_eq]

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.

filters[time_watched_hours_eq]

string

Filter records where time_watched_hours is equal to the specified value.

filters[time_watched_hours_gt]

string

Filter records where time_watched_hours is greater than the specified value.

filters[time_watched_hours_gte]

string

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

filters[time_watched_hours_lt]

string

Filter records where time_watched_hours is less than the specified value.

filters[time_watched_hours_lte]

string

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

filters[time_watched_minutes_eq]

string

Filter records where time_watched_minutes is equal to the specified value.

filters[time_watched_minutes_gt]

string

Filter records where time_watched_minutes is greater than the specified value.

filters[time_watched_minutes_gte]

string

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

filters[time_watched_minutes_lt]

string

Filter records where time_watched_minutes is less than the specified value.

filters[time_watched_minutes_lte]

string

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

filters[time_watched_seconds_eq]

string

Filter records where time_watched_seconds is equal to the specified value.

filters[time_watched_seconds_gt]

string

Filter records where time_watched_seconds is greater than the specified value.

filters[time_watched_seconds_gte]

string

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

filters[time_watched_seconds_lt]

string

Filter records where time_watched_seconds is less than the specified value.

filters[time_watched_seconds_lte]

string

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

filters[avg_play_length_hours_eq]

string

Filter records where avg_play_length_hours is equal to the specified value.

filters[avg_play_length_hours_gt]

string

Filter records where avg_play_length_hours is greater than the specified value.

filters[avg_play_length_hours_gte]

string

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

filters[avg_play_length_hours_lt]

string

Filter records where avg_play_length_hours is less than the specified value.

filters[avg_play_length_hours_lte]

string

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

filters[avg_play_length_minutes_eq]

string

Filter records where avg_play_length_minutes is equal to the specified value.

filters[avg_play_length_minutes_gt]

string

Filter records where avg_play_length_minutes is greater than the specified value.

filters[avg_play_length_minutes_gte]

string

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

filters[avg_play_length_minutes_lt]

string

Filter records where avg_play_length_minutes is less than the specified value.

filters[avg_play_length_minutes_lte]

string

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

filters[avg_play_length_seconds_eq]

string

Filter records where avg_play_length_seconds is equal to the specified value.

filters[avg_play_length_seconds_gt]

string

Filter records where avg_play_length_seconds is greater than the specified value.

filters[avg_play_length_seconds_gte]

string

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

filters[avg_play_length_seconds_lt]

string

Filter records where avg_play_length_seconds is less than the specified value.

filters[avg_play_length_seconds_lte]

string

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

filters[plays_eq]

string

Filter records where plays is equal to the specified value.

filters[plays_gt]

string

Filter records where plays is greater than the specified value.

filters[plays_gte]

string

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

filters[plays_lt]

string

Filter records where plays is less than the specified value.

filters[plays_lte]

string

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

filters[video_id_eq]

string

Filter records by video_id

filters[video_title_eq]

string

Filter records by video_title

filters[consumer_id_eq]

string

Filter records by consumer_id

interval

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

sort_by

string

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

limit

integer

Limit the number of records returned

Responses

Language

Credentials

Query


xxxxxxxxxx
1
curl --request GET \
2
     --url https://analytics.zype.com/v2/engagement \
3
     --header 'accept: application/json'

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

application/json

200See below for example responses

422Unprocessable entity