View Time

get

https://analytics.zype.com/v3/engagement/view_time

The view time endpoint provides insights on the average amount of time content has been watched. It returns data on the average amount of time content has been watched, which can be filtered by various parameters such as date range, content type, and more. This is useful for understanding viewer engagement and content performance.

Query Params

filters[start_date_gt]

string

Filter records created after the specified start_date.

filters[start_date_gte]

string

Filter records created on or after the specified start_date. If no start_date filter is specified, then data returned will date back two weeks ago.

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.

filters[start_time_gt]

string

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

filters[start_time_gte]

string

Filter records created on or after the specified start_time. If no start_time filter is specified, then data returned will date back two weeks ago. Comparison is date and time specific. If no time values are submitted, 00:00:00 UTC is assumed.

filters[start_time_lt]

string

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

filters[start_time_lte]

string

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

filters[start_time_eq]

string

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

filters[played_gt]

string

Filter records where played is greater than the specified value.

filters[video_id_eq]

string

Filter records by video_id

filters[video_title_eq]

string

Filter records by video_title

filters[platform_eq]

string

Filter records by platform (e.g., Web, etc.)

filters[consumer_id_eq]

string

Filter records by consumer_id

filters[subscription_id_eq]

string

Filter records by subscription_id

filters[transaction_id_eq]

string

Filter records by transaction_id

filters[monetization_type_eq]

string

Filter records by monetization_type (e.g., subscription, etc.)

filters[playlist_id_eq]

string

Filter records by playlist_id

filters[playlist_name_eq]

string

Filter records by playlist_name

filters[app_id_eq]

string

Filter records by app_id

filters[app_name_eq]

string

Filter records by app_name

filters[app_version_eq]

string

Filter records by app_version

filters[player_name_eq]

string

Filter records by player_name

filters[player_version_eq]

string

Filter records by player_version

filters[content_type_eq]

string

Filter records by content_type (e.g., video, audio, etc.)

filters[playout_channel_id_eq]

string

Filter records by playout_channel_id

filters[playout_channel_name_eq]

string

Filter records by playout_channel_name

filters[playout_destination_id_eq]

string

Filter records by playout_destination_id

filters[playout_destination_name_eq]

string

Filter records by playout_destination_name

filters[platform_source_eq]

string

Filter records by platform_source

filters[external_user_id_eq]

string

Filter records by external_user_id

filters[domain_eq]

string

Filter records by domain

filters[country_eq]

string

Filter records by country (e.g., US, CA, etc.)

interval

string | null

enum

Defaults to day

Group records by time intervals. Accepted values: hour, day, month.

Allowed:

unit

string | null

enum

Defaults to hour

The unit of time to use when calculating the 'view time' metric. Accepted values: second, minute, hour.

Allowed:

group_by

array of strings or null

Group records by one or more properties of the data returned

group_by

sort_by

string

enum

Defaults to day_desc

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

limit

integer

Limit the number of records returned

offset

integer

Offset the number of records returned by the specified value. For example, if you have 100 records and you set offset=10, then the first 10 records will be skipped and the next 90 will be returned.

Responses

200See below for example responses

422Unprocessable entity