# Fetch viewer analytics data for a VOD stream (Available from version 1.11) This operation returns the live and historic viewer data for a specific VOD stream. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data. Querying live data 1. To get data for currently live streams, do not send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send any query parameters (to, from, or include), the total number of viewers is returned. Querying historic data 1. To get data for streams that ran previously, send from and to values. 2. Use the include query parameter to specify what data you want to return, including: countries, renditions, devices, and trend data. If you don't send include values, the total number of viewers is returned. If the time range between from and to query parameters is: Less than 60 minutes, the cache time between responses is 10 seconds. More than 60 minutes, the cache time between responses is 60 seconds. Endpoint: GET /analytics/viewers/vod_streams/{id} Version: v2.0 ## Path parameters: - `id` (string, required) The unique alphanumeric string that identifies the VOD stream. ## Query parameters: - `from` (string) Use this parameter, along with to, to return historic viewer data. The start of the range of time you want to view. Specify YYYY-DD-MMT HH:MM:SSZ where HH is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the from query parameter without setting the to query parameter, the data returned will reflect 30 days starting at the from date, or data up to to the current day, whichever is shorter. Example: 2024-03-14T10:31:54.486Z - `to` (string) Use this parameter, along with from, to return historic viewer data. The end of the range of time you want to view. Specify YYYY-DD-MMT HH:MM:SSZ where HH is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the to query parameter without setting the from query parameter, the data returned will be from the past 30 days or from your last invoice date, whichever is shorter. Example: 2024-04-13T10:31:54.486Z - `include` (string) Specify the data you want returned in the response. You can send a comma-separated list of values. Valid values are: countries, renditions, devices, and trend. Example: countries,trend - `time_zone` (string) Specify the time zone you want the returned data to reflect. Click to expand for the full list of valid values | Locations | Wowza Video time_zone value | |---|---| | International Date Line West | Etc/GMT+12 | | Midway Island | Pacific/Midway | | American Samoa | Pacific/Pago_Pago | | Hawaii | Pacific/Honolulu | | Alaska | America/Juneau | | Pacific Time (US & Canada) | America/Los_Angeles | | Tijuana | America/Tijuana | | Mountain Time (US & Canada) | America/Denver | | Arizona | America/Phoenix | | Chihuahua | America/Chihuahua | | Mazatlan | America/Mazatlan | | Central Time (US & Canada) | America/Chicago | | Saskatchewan | America/Regina | | Guadalajara | America/Mexico_City | | Mexico City | America/Mexico_City | | Monterrey | America/Monterrey | | Central America | America/Guatemala | | Eastern Time (US & Canada) | America/New_York | | Indiana (East) | America/Indiana/Indianapolis | | Bogota | America/Bogota | | Lima | America/Lima | | Quito | America/Lima | | Atlantic Time (Canada) | America/Halifax | | Caracas | America/Caracas | | La Paz | America/La_Paz | | Santiago | America/Santiago | | Newfoundland | America/St_Johns | | Brasilia | America/Sao_Paulo | | Buenos Aires | America/Argentina/Buenos_Aires | | Montevideo | America/Montevideo | | Georgetown | America/Guyana | | Puerto Rico | America/Puerto_Rico | | Greenland | America/Godthab | | Mid-Atlantic | Atlantic/South_Georgia | | Azores | Atlantic/Azores | | Cape Verde Is. | Atlantic/Cape_Verde | | Dublin | Europe/Dublin | | Edinburgh | Europe/London | | Lisbon | Europe/Lisbon | | London | Europe/London | | Casablanca | Africa/Casablanca | | Monrovia | Africa/Monrovia | | UTC | Etc/UTC | | Belgrade | Europe/Belgrade | | Bratislava | Europe/Bratislava | | Budapest | Europe/Budapest | | Ljubljana | Europe/Ljubljana | | Prague | Europe/Prague | | Sarajevo | Europe/Sarajevo | | Skopje | Europe/Skopje | | Warsaw | Europe/Warsaw | | Zagreb | Europe/Zagreb | | Brussels | Europe/Brussels | | Copenhagen | Europe/Copenhagen | | Madrid | Europe/Madrid | | Paris | Europe/Paris | | Amsterdam | Europe/Amsterdam | | Berlin | Europe/Berlin | | Bern | Europe/Zurich | | Zurich | Europe/Zurich | | Rome | Europe/Rome | | Stockholm | Europe/Stockholm | | Vienna | Europe/Vienna | | West Central Africa | Africa/Algiers | | Bucharest | Europe/Bucharest | | Cairo | Africa/Cairo | | Helsinki | Europe/Helsinki | | Kyiv | Europe/Kiev | | Riga | Europe/Riga | | Sofia | Europe/Sofia | | Tallinn | Europe/Tallinn | | Vilnius | Europe/Vilnius | | Athens | Europe/Athens | | Istanbul | Europe/Istanbul | | Minsk | Europe/Minsk | | Jerusalem | Asia/Jerusalem | | Harare | Africa/Harare | | Pretoria | Africa/Johannesburg | | Kaliningrad | Europe/Kaliningrad | | Moscow | Europe/Moscow | | St. Petersburg | Europe/Moscow | | Volgograd | Europe/Volgograd | | Samara | Europe/Samara | | Kuwait | Asia/Kuwait | | Riyadh | Asia/Riyadh | | Nairobi | Africa/Nairobi | | Baghdad | Asia/Baghdad | | Tehran | Asia/Tehran | | Abu Dhabi | Asia/Muscat | | Muscat | Asia/Muscat | | Baku | Asia/Baku | | Tbilisi | Asia/Tbilisi | | Yerevan | Asia/Yerevan | | Kabul | Asia/Kabul | | Ekaterinburg | Asia/Yekaterinburg | | Islamabad | Asia/Karachi | | Karachi | Asia/Karachi | | Tashkent | Asia/Tashkent | | Chennai | Asia/Kolkata | | Kolkata | Asia/Kolkata | | Mumbai | Asia/Kolkata | | New Delhi | Asia/Kolkata | | Kathmandu | Asia/Kathmandu | | Astana | Asia/Dhaka | | Dhaka | Asia/Dhaka | | Sri Jayawardenepura | Asia/Colombo | | Almaty | Asia/Almaty | | Novosibirsk | Asia/Novosibirsk | | Rangoon | Asia/Rangoon | | Bangkok | Asia/Bangkok | | Hanoi | Asia/Bangkok | | Jakarta | Asia/Jakarta | | Krasnoyarsk | Asia/Krasnoyarsk | | Beijing | Asia/Shanghai | | Chongqing | Asia/Chongqing | | Hong Kong | Asia/Hong_Kong | | Urumqi | Asia/Urumqi | | Kuala Lumpur | Asia/Kuala_Lumpur | | Singapore | Asia/Singapore | | Taipei | Asia/Taipei | | Perth | Australia/Perth | | Irkutsk | Asia/Irkutsk | | Ulaanbaatar | Asia/Ulaanbaatar | | Seoul | Asia/Seoul | | Osaka | Asia/Tokyo | | Sapporo | Asia/Tokyo | | Tokyo | Asia/Tokyo | | Yakutsk | Asia/Yakutsk | | Darwin | Australia/Darwin | | Adelaide | Australia/Adelaide | | Canberra | Australia/Melbourne | | Melbourne | Australia/Melbourne | | Sydney | Australia/Sydney | | Brisbane | Australia/Brisbane | | Hobart | Australia/Hobart | | Vladivostok | Asia/Vladivostok | | Guam | Pacific/Guam | | Port Moresby | Pacific/Port_Moresby | | Magadan | Asia/Magadan | | Srednekolymsk | Asia/Srednekolymsk | | Solomon Is. | Pacific/Guadalcanal | | New Caledonia | Pacific/Noumea | | Fiji | Pacific/Fiji | | Kamchatka | Asia/Kamchatka | | Marshall Is. | Pacific/Majuro | | Auckland | Pacific/Auckland | | Wellington | Pacific/Auckland | | Nuku'alofa | Pacific/Tongatapu | | Tokelau Is. | Pacific/Fakaofo | | Chatham Is. | Pacific/Chatham | | Samoa | Pacific/Apia | Default: Etc/UTC Example: America/New_York ## Response 200 fields (application/json): - `vod_stream` (object) Example: {"id":"tvctq36g","viewers":7,"countries":[{"code":"US","viewers":3},{"code":"DE","viewers":4}],"renditions":[{"name":720,"viewers":7}],"devices":[{"name":"Desktop","viewers":7}],"time_zone":"America/New_York","trend":[{"sampled_at":"2024-03-14T00:00:00Z","viewers":7},{"sampled_at":"2024-03-15T00:00:00Z","viewers":7},{"sampled_at":"2024-03-16T00:00:00Z","viewers":7},{"sampled_at":"2024-03-17T00:00:00Z","viewers":7}]} - `vod_stream.id` (string) The unique alphanumeric string that identifies the VOD stream. Example: "tvctq36g" - `vod_stream.viewers` (integer) The total number of unique viewers to download at least one chunk of the VOD stream. A unique viewer is a single IP address; multiple users that share the same IP address are counted once. Example: 7 - `vod_stream.countries` (object) An array of viewer countries. Example: [{"code":"US","viewers":3},{"code":"DE","viewers":4}] - `vod_stream.countries.code` (string) A country code where the stream was requested. - `vod_stream.renditions` (object) An array of viewer renditions. Example: [{"name":720,"viewers":7}] - `vod_stream.renditions.name` (integer) The rendition of the stream played. A rendition name is the smaller number of the resolution. The resolution is [width]x[height] in which the stream was played. Renditions names have to be unique. If you've created two renditions that have the same height and width, Wowza Video increments the value of the height and uses that as the rendition name. Example: Two renditions of 1280x720 will result in rendition names of 720 and 721. - `vod_stream.renditions.viewers` (integer) The total number of unique viewers to download at least one chunk of the stream. A unique viewer is a single IP address; multiple users that share the same IP address are counted once. - `vod_stream.devices` (object) An array of viewer devices. Example: [{"name":"Desktop","viewers":7}] - `vod_stream.devices.name` (string) A device where the stream was played. - `vod_stream.trend` (object) An array of viewer trend data. The granularity of sampled data changes based on the from and to query values you use: 0 minutes to 8 hours - Samples returned per minute 8 hours, 1 second to 24 hours - Samples returned per hour 24 hours, 1 second to 175 days - Samples returned per day 175 days to 14 years - Samples returned per month 14 years or greater - Samples returned per year Defaults: from = last billing date, to = end of current day Example: [{"sampled_at":"2024-03-14T00:00:00Z","viewers":7},{"sampled_at":"2024-03-15T00:00:00Z","viewers":7},{"sampled_at":"2024-03-16T00:00:00Z","viewers":7},{"sampled_at":"2024-03-17T00:00:00Z","viewers":7}] - `vod_stream.trend.sampled_at` (string) The date and time the trend data was sampled. - `vod_stream.time_zone` (string) The time zone in which the data is returned. The default time zone in which the data is returned is Etc/UTC. Example: "America/New_York" - `vod_stream.limits` (object) The time frame represented in the response. - `vod_stream.limits.from` (string) The start of the range of time represented in the response. - `vod_stream.limits.to` (string) The end of the range of time represented in the response. ## Response 401 fields (application/json): - `meta` (object, required) - `meta.status` (integer) - `meta.code` (string) - `meta.title` (string) - `meta.message` (string) - `meta.description` (string) - `meta.links` (array) ## Response 403 fields (application/json): - `meta` (object, required) - `meta.status` (integer) - `meta.code` (string) - `meta.title` (string) - `meta.message` (string) - `meta.description` (string) - `meta.links` (array) ## Response 404 fields (application/json): - `meta` (object, required) - `meta.status` (integer) - `meta.code` (string) - `meta.title` (string) - `meta.message` (string) - `meta.description` (string) - `meta.links` (array) ## Response 410 fields (application/json): - `meta` (object, required) - `meta.status` (integer) - `meta.code` (string) - `meta.title` (string) - `meta.message` (string) - `meta.description` (string) - `meta.links` (array) ## Response 422 fields (application/json): - `meta` (object, required) - `meta.status` (integer) - `meta.code` (string) - `meta.title` (string) - `meta.message` (string) - `meta.description` (string) - `meta.links` (array)