List Stream Hours (V2)

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

This endpoint will retrieve stream hour 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[device_name_eq]

string | null

Filter by device name. Device names are case sensitive - current options include Roku, Chromecast, Desktop, iOS (Native), iOS (HTML5), Apple TV, Windows Phone (HTML5), Xbox (HTML5), Android (Native), FireTV, Xbox, BlackBerry (HTML5), Android (HTML5), Metrological, OperaTV, Xumo, SmartTV

filters[video_id_eq]

string

Filter by the video ID.

filters[stream_type_eq]

string | null

Filter by the type of stream. Options are vod, live, and download.

filters[consumer_id_eq]

string

Filter by the consumer ID.

filters[consumer_email_eq]

string

Filter by a specific consumer's email. (Example: filters[consumer_email_eq]=consumer@zype.com)

filters[monetized_option_eq]

string

Filter by the type of monetization of the videos. Options are free, paid and avod.

filters[country_eq]

string | null

Filter by the the request origin country's 2 letter ISO 3166-1 alpha-2 code (Example: US, FR, GB, CA).

group_by

array of strings or null

Group records by one or more properties of the data returned -- accepted values are: start_date, device_name, video_title, video_id, stream_type, consumer_email, consumer_id, monetized_option, country

group_by

sort_by

string | null

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

view_mode

string | null

Defaults to summary

Set view mode to detailed to return all available properties for all records.

Responses

200See below for example responses

422Unprocessable entity