--- updatedAt: 2026-04-22T18:02:08.000Z agentTools: projectIndex: https://docs.zype.com/llms.txt --- # List Stream Hours This endpoint will retrieve stream hour data for your property. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Analytics (V3)", "version": "1.0.0", "description": "" }, "servers": [ { "url": "https://analytics.zype.com" } ], "components": { "securitySchemes": { "api_key": { "type": "apiKey", "name": "api_key", "in": "query" } } }, "security": [ { "api_key": [] } ], "paths": { "/v3/platform_dynamics/stream_hours": { "get": { "x-server-name": "analytics-api", "summary": "List Stream Hours", "description": "This endpoint will retrieve stream hour data for your property.", "tags": [ "Platform Dynamics" ], "operationId": "streamHoursV3", "parameters": [ { "name": "filters[start_date_gt]", "in": "query", "schema": { "type": "string", "example": "2020-10-04" }, "description": "Filter records created after the specified `start_date`. \nNeeds to be used in with `start_date_lt` (or `start_date_lte`).\nIf no start_date is specified, then data returned will date back two days ago." }, { "name": "filters[start_date_gte]", "in": "query", "schema": { "type": "string" }, "description": "Filter records created on or after the specified `start_date`. Needs to be used in with `start_date_lt` (or `start_date_lte`)" }, { "name": "filters[start_date_lt]", "in": "query", "schema": { "type": "string" }, "description": "Filter records created before the specified `start_date`. Needs to be used in with `start_date_gt` (or `start_date_gte`)" }, { "name": "filters[start_date_lte]", "in": "query", "schema": { "type": "string" }, "description": "Filter records created on or before the specified `start_date`. Needs to be used in with `start_date_gt` (or `start_date_gte`)" }, { "name": "filters[start_date_eq]", "in": "query", "schema": { "type": "string" }, "description": "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." }, { "name": "filters[device_name_eq]", "in": "query", "schema": { "type": "string", "nullable": true, "enum": [ null, "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" ] }, "description": "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`" }, { "name": "filters[video_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter by the video ID." }, { "name": "filters[stream_type_eq]", "in": "query", "schema": { "type": "string", "nullable": true, "enum": [ null, "vod", "live", "download" ] }, "description": "Filter by the type of stream. Options are `vod`, `live`, and `download`." }, { "name": "filters[consumer_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter by the consumer ID." }, { "name": "filters[consumer_email_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter by a specific consumer's email. (Example: filters[consumer_email_eq]=consumer@zype.com)" }, { "name": "filters[monetized_option_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter by the type of monetization of the videos. Options are `free`, `paid` and `avod`." }, { "name": "filters[country_eq]", "in": "query", "schema": { "type": "string", "enum": [ null, "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "nullable": true }, "description": "Filter by the the request origin country's 2 letter ISO 3166-1 alpha-2 code (Example: `US`, `FR`, `GB`, `CA`)." }, { "name": "filters[time_slice_bucket_eq]", "in": "query", "schema": { "type": "string", "nullable": true, "enum": [ null, "15 min", "30 min", "60 min" ] }, "description": "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." }, { "name": "filters[time_slice_start_gt]", "in": "query", "schema": { "type": "string" }, "description": "Filter time slice results after the specified start date/time. The format is 24hour UTC: `YYYY-MM-DD HH:MM:SS`" }, { "name": "filters[time_slice_start_gte]", "in": "query", "schema": { "type": "string" }, "description": "Filter time slice results on or after the specified start date/time. The format is 24hour UTC: `YYYY-MM-DD HH:MM:SS`" }, { "name": "filters[time_slice_end_lt]", "in": "query", "schema": { "type": "string" }, "description": "Filter time slice results before the specified end date/time. The format is 24hour UTC: `YYYY-MM-DD HH:MM:SS`" }, { "name": "filters[time_slice_end_lte]", "in": "query", "schema": { "type": "string" }, "description": "Filter time slice reslts on or before the specified end date/time. The format is 24hour UTC: `YYYY-MM-DD HH:MM:SS`" }, { "name": "email_address", "in": "query", "schema": { "type": "string" }, "description": "Required when group_by is set to \"all\". Results will be delivered as a downloadable CSV link via email." }, { "name": "group_by", "in": "query", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "nullable": true, "enum": [ null, "start_date", "device_name", "video_id", "stream_type", "consumer_email", "consumer_id", "monetized_option", "country", "all" ] } }, "description": "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`" }, { "name": "sort_by", "in": "query", "schema": { "type": "string", "nullable": true, "enum": [ null, "start_date_asc", "start_date_desc", "device_name_asc", "device_name_desc", "video_id_asc", "video_id_desc", "stream_type_asc", "stream_type_desc", "consumer_email_asc", "consumer_email_desc", "consumer_id_asc", "consumer_id_desc", "monetized_option_asc", "monetized_option_desc", "country_asc", "country_desc", "impressions_asc", "impressions_desc", "bytes_streamed_asc", "bytes_streamed_desc", "stream_hours_asc", "stream_hours_desc" ] }, "description": "Sort results by a value of a specific property + '_' sort direction (Example - sort_by=start_date_asc, or sort_by=start_date_desc)" }, { "name": "view_mode", "in": "query", "schema": { "type": "string", "enum": [ "detailed", "summary" ], "default": "summary" }, "description": "Set view mode to detailed to return all available properties for all records." } ], "responses": { "200": { "description": "See below for example responses", "content": { "application/json": { "schema": { "title": "StreamHoursV3Response", "type": "object", "properties": { "data": { "type": "array", "items": { "title": "StreamHour", "type": "object", "properties": { "start_date": { "type": "string" }, "device_name": { "type": "string" }, "video_id": { "type": "string" }, "video_title": { "type": "string" }, "stream_type": { "type": "string" }, "consumer_id": { "type": "string" }, "consumer_email": { "type": "string" }, "monetized_option": { "type": "string" }, "country": { "type": "string" }, "time_slice": { "type": "string" }, "time_slice_start": { "type": "string" }, "time_slice_end": { "type": "string" } } } } } } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/paths/~1v3~1engagement~1plays/get/responses/422/content/application~1json/schema" } } } } } } }, "/v3/engagement/plays": { "get": { "x-server-name": "analytics-api", "summary": "Plays", "description": "The plays endpoint provides insights on the number of times content has been played. It returns data on how many times content has been played, 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.", "tags": [ "Engagement" ], "operationId": "plays-v3", "parameters": [ { "name": "filters[start_date_gt]", "in": "query", "schema": { "type": "string" }, "description": "Filter records created after the specified `start_date`." }, { "name": "filters[start_date_gte]", "in": "query", "schema": { "type": "string" }, "description": "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." }, { "name": "filters[start_date_lt]", "in": "query", "schema": { "type": "string" }, "description": "Filter records created before the specified `start_date`." }, { "name": "filters[start_date_lte]", "in": "query", "schema": { "type": "string" }, "description": "Filter records created on or before the specified `start_date`." }, { "name": "filters[start_date_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records created on the specified `start_date`." }, { "name": "filters[start_time_gt]", "in": "query", "schema": { "type": "string" }, "description": "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." }, { "name": "filters[start_time_gte]", "in": "query", "schema": { "type": "string" }, "description": "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." }, { "name": "filters[start_time_lt]", "in": "query", "schema": { "type": "string" }, "description": "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." }, { "name": "filters[start_time_lte]", "in": "query", "schema": { "type": "string" }, "description": "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." }, { "name": "filters[start_time_eq]", "in": "query", "schema": { "type": "string" }, "description": "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." }, { "name": "filters[played_gt]", "in": "query", "schema": { "type": "string" }, "description": "Filter records where `played` is greater than the specified value." }, { "name": "filters[video_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `video_id`" }, { "name": "filters[video_title_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `video_title`" }, { "name": "filters[platform_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `platform` (e.g., Web, etc.)" }, { "name": "filters[consumer_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `consumer_id`" }, { "name": "filters[subscription_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `subscription_id`" }, { "name": "filters[transaction_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `transaction_id`" }, { "name": "filters[monetization_type_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `monetization_type` (e.g., subscription, etc.)" }, { "name": "filters[playlist_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `playlist_id`" }, { "name": "filters[playlist_name_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `playlist_name`" }, { "name": "filters[app_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `app_id`" }, { "name": "filters[app_name_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `app_name`" }, { "name": "filters[app_version_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `app_version`" }, { "name": "filters[content_type_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `content_type` (e.g., video, audio, etc.)" }, { "name": "filters[playout_channel_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `playout_channel_id`" }, { "name": "filters[playout_channel_name_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `playout_channel_name`" }, { "name": "filters[playout_destination_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `playout_destination_id`" }, { "name": "filters[playout_destination_name_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `playout_destination_name`" }, { "name": "filters[platform_source_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `platform_source`" }, { "name": "filters[external_user_id_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `external_user_id`" }, { "name": "filters[domain_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `domain`" }, { "name": "filters[country_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `country` (e.g., US, CA, etc.)" }, { "name": "filters[is_live_eq]", "in": "query", "schema": { "type": "string" }, "description": "Filter records by `is_live`" }, { "name": "interval", "in": "query", "schema": { "type": "string", "nullable": true, "default": "day", "enum": [ null, "hour", "day", "month", "total" ] }, "description": "Group records by time intervals. Accepted values: `hour`, `day`, `month`, `total`." }, { "name": "group_by", "in": "query", "style": "form", "explode": false, "schema": { "type": "array", "items": { "nullable": true, "type": "string", "enum": [ null, "video_id", "video_title", "platform", "consumer_id", "subscription_id", "transaction_id", "monetization_type", "playlist_id", "playlist_name", "app_id", "app_name", "app_version", "content_type", "playout_channel_id", "playout_channel_name", "playout_destination_id", "playout_destination_name", "platform_source", "external_user_id", "domain", "country", "is_live" ] } }, "description": "Group records by one or more properties of the data returned" }, { "name": "sort_by", "in": "query", "schema": { "type": "string", "default": "day_desc", "enum": [ null, "hour_asc", "hour_desc", "day_asc", "day_desc", "month_asc", "month_desc", "value_asc", "value_desc", "video_id_asc", "video_id_desc", "video_title_asc", "video_title_desc", "platform_asc", "platform_desc", "consumer_id_asc", "consumer_id_desc", "subscription_id_asc", "subscription_id_desc", "transaction_id_asc", "transaction_id_desc", "monetization_type_asc", "monetization_type_desc", "playlist_id_asc", "playlist_id_desc", "playlist_name_asc", "playlist_name_desc", "app_id_asc", "app_id_desc", "app_name_asc", "app_name_desc", "app_version_asc", "app_version_desc", "content_type_asc", "content_type_desc", "playout_channel_id_asc", "playout_channel_id_desc", "playout_channel_name_asc", "playout_channel_name_desc", "playout_destination_id_asc", "playout_destination_id_desc", "playout_destination_name_asc", "playout_destination_name_desc", "platform_source_asc", "platform_source_desc", "external_user_id_asc", "external_user_id_desc", "domain_asc", "domain_desc", "country_asc", "country_desc", "is_live_asc", "is_live_desc" ] }, "description": "Sort results by value of a specific property + '_' + sort direction (Example - sort_by=start_time_asc, or sort_by=video_id_desc)" }, { "name": "limit", "in": "query", "schema": { "type": "integer" }, "description": "Limit the number of records returned" }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "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": { "200": { "description": "See below for example responses", "content": { "application/json": { "schema": { "title": "PlaysResponse", "type": "object", "properties": { "response": { "title": "Play", "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date of the play count." }, "value": { "type": "number", "format": "float", "description": "The number of plays on the given date." } } } } } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "title": "AnalyticsNotFound", "type": "object", "properties": { "errors": { "type": "string" } } } } } } } } } } } ```