HomeAPI Reference
API Reference
Start typing to search…

List Stream Hours

get
https://analytics.zype.com/v3/platform_dynamics/stream_hours

This endpoint will retrieve stream hour data for your property.

Query Params
string

Filter records created after the specified start_date. Needs to be used in with start_date_lt (or start_date_lte). If no start_date is specified, then data returned will date back two days ago.

string

Filter records created on or after the specified start_date. Needs to be used in with start_date_lt (or start_date_lte)

string

Filter records created before the specified start_date. Needs to be used in with start_date_gt (or start_date_gte)

string

Filter records created on or before the specified start_date. Needs to be used in with start_date_gt (or start_date_gte)

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 | null
enum

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

string

Filter by the video ID.

string | null
enum

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

Allowed:
string

Filter by the consumer ID.

string

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

string

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

string | null
enum

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

string | null
enum

Filter by time slice bucket. Supported values are: 15 min, 30 min, and 60 min. ** If filtering by time_slice_bucket, you also need to filter by time_slice_start_gt or time_slice_start_gte AND time_slice_end_lt or time_slice_end_lte.

Allowed:
string

Filter time slice results after the specified start date/time. The format is 24hour UTC: YYYY-MM-DD HH:MM:SS

string

Filter time slice results on or after the specified start date/time. The format is 24hour UTC: YYYY-MM-DD HH:MM:SS

string

Filter time slice results before the specified end date/time. The format is 24hour UTC: YYYY-MM-DD HH:MM:SS

string

Filter time slice reslts on or before the specified end date/time. The format is 24hour UTC: YYYY-MM-DD HH:MM:SS

string

Required when group_by is set to "all". Results will be delivered as a downloadable CSV link via email.

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_id, stream_type, consumer_email, consumer_id, monetized_option, country, all

group_by
string | null
enum

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

string
enum
Defaults to summary

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

Allowed:
Responses

Updated 5 months ago

Language
Credentials
Query
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago