Sign in

v1

latestOpenAPI 3.0.2Terms of Use2026-08-061441681.6 MB
analytics_viewers

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:

<ul><li>Less than 60 minutes, the cache time between responses is 10 seconds.</li> <li>More than 60 minutes, the cache time between responses is 60 seconds.</li>
get/analytics/viewers/vod_streams/{id}

Path parameters

idstring required

The unique alphanumeric string that identifies the VOD stream.

Query parameters

fromstring date-time

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

tostring date-time

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.

Example: 2024-03-14T10:31:54.486Z

includestring

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_zonestring

Specify the time zone you want the returned data to reflect.

<details> <summary>Click to expand for the full list of valid values</summary>
LocationsWowza Video time_zone value
International Date Line WestEtc/GMT+12
Midway IslandPacific/Midway
American SamoaPacific/Pago_Pago
HawaiiPacific/Honolulu
AlaskaAmerica/Juneau
Pacific Time (US & Canada)America/Los_Angeles
TijuanaAmerica/Tijuana
Mountain Time (US & Canada)America/Denver
ArizonaAmerica/Phoenix
ChihuahuaAmerica/Chihuahua
MazatlanAmerica/Mazatlan
Central Time (US & Canada)America/Chicago
SaskatchewanAmerica/Regina
GuadalajaraAmerica/Mexico_City
Mexico CityAmerica/Mexico_City
MonterreyAmerica/Monterrey
Central AmericaAmerica/Guatemala
Eastern Time (US & Canada)America/New_York
Indiana (East)America/Indiana/Indianapolis
BogotaAmerica/Bogota
LimaAmerica/Lima
QuitoAmerica/Lima
Atlantic Time (Canada)America/Halifax
CaracasAmerica/Caracas
La PazAmerica/La_Paz
SantiagoAmerica/Santiago
NewfoundlandAmerica/St_Johns
BrasiliaAmerica/Sao_Paulo
Buenos AiresAmerica/Argentina/Buenos_Aires
MontevideoAmerica/Montevideo
GeorgetownAmerica/Guyana
Puerto RicoAmerica/Puerto_Rico
GreenlandAmerica/Godthab
Mid-AtlanticAtlantic/South_Georgia
AzoresAtlantic/Azores
Cape Verde Is.Atlantic/Cape_Verde
DublinEurope/Dublin
EdinburghEurope/London
LisbonEurope/Lisbon
LondonEurope/London
CasablancaAfrica/Casablanca
MonroviaAfrica/Monrovia
UTCEtc/UTC
BelgradeEurope/Belgrade
BratislavaEurope/Bratislava
BudapestEurope/Budapest
LjubljanaEurope/Ljubljana
PragueEurope/Prague
SarajevoEurope/Sarajevo
SkopjeEurope/Skopje
WarsawEurope/Warsaw
ZagrebEurope/Zagreb
BrusselsEurope/Brussels
CopenhagenEurope/Copenhagen
MadridEurope/Madrid
ParisEurope/Paris
AmsterdamEurope/Amsterdam
BerlinEurope/Berlin
BernEurope/Zurich
ZurichEurope/Zurich
RomeEurope/Rome
StockholmEurope/Stockholm
ViennaEurope/Vienna
West Central AfricaAfrica/Algiers
BucharestEurope/Bucharest
CairoAfrica/Cairo
HelsinkiEurope/Helsinki
KyivEurope/Kiev
RigaEurope/Riga
SofiaEurope/Sofia
TallinnEurope/Tallinn
VilniusEurope/Vilnius
AthensEurope/Athens
IstanbulEurope/Istanbul
MinskEurope/Minsk
JerusalemAsia/Jerusalem
HarareAfrica/Harare
PretoriaAfrica/Johannesburg
KaliningradEurope/Kaliningrad
MoscowEurope/Moscow
St. PetersburgEurope/Moscow
VolgogradEurope/Volgograd
SamaraEurope/Samara
KuwaitAsia/Kuwait
RiyadhAsia/Riyadh
NairobiAfrica/Nairobi
BaghdadAsia/Baghdad
TehranAsia/Tehran
Abu DhabiAsia/Muscat
MuscatAsia/Muscat
BakuAsia/Baku
TbilisiAsia/Tbilisi
YerevanAsia/Yerevan
KabulAsia/Kabul
EkaterinburgAsia/Yekaterinburg
IslamabadAsia/Karachi
KarachiAsia/Karachi
TashkentAsia/Tashkent
ChennaiAsia/Kolkata
KolkataAsia/Kolkata
MumbaiAsia/Kolkata
New DelhiAsia/Kolkata
KathmanduAsia/Kathmandu
AstanaAsia/Dhaka
DhakaAsia/Dhaka
Sri JayawardenepuraAsia/Colombo
AlmatyAsia/Almaty
NovosibirskAsia/Novosibirsk
RangoonAsia/Rangoon
BangkokAsia/Bangkok
HanoiAsia/Bangkok
JakartaAsia/Jakarta
KrasnoyarskAsia/Krasnoyarsk
BeijingAsia/Shanghai
ChongqingAsia/Chongqing
Hong KongAsia/Hong_Kong
UrumqiAsia/Urumqi
Kuala LumpurAsia/Kuala_Lumpur
SingaporeAsia/Singapore
TaipeiAsia/Taipei
PerthAustralia/Perth
IrkutskAsia/Irkutsk
UlaanbaatarAsia/Ulaanbaatar
SeoulAsia/Seoul
OsakaAsia/Tokyo
SapporoAsia/Tokyo
TokyoAsia/Tokyo
YakutskAsia/Yakutsk
DarwinAustralia/Darwin
AdelaideAustralia/Adelaide
CanberraAustralia/Melbourne
MelbourneAustralia/Melbourne
SydneyAustralia/Sydney
BrisbaneAustralia/Brisbane
HobartAustralia/Hobart
VladivostokAsia/Vladivostok
GuamPacific/Guam
Port MoresbyPacific/Port_Moresby
MagadanAsia/Magadan
SrednekolymskAsia/Srednekolymsk
Solomon Is.Pacific/Guadalcanal
New CaledoniaPacific/Noumea
FijiPacific/Fiji
KamchatkaAsia/Kamchatka
Marshall Is.Pacific/Majuro
AucklandPacific/Auckland
WellingtonPacific/Auckland
Nuku'alofaPacific/Tongatapu
Tokelau Is.Pacific/Fakaofo
Chatham Is.Pacific/Chatham
SamoaPacific/Apia
</details>

Default: Etc/UTC

Example: America/New_York

Response

Success

Example response

{
  "vod_stream": {
    "id": "tvctq36g",
    "viewers": 7,
    "countries": [
      {
        "code": "US",
        "viewers": 3
      },
      {
        "code": "DE",
        "viewers": 4
      }
    ],
    "renditions": [
      {
        "name": 720,
        "viewers": 7
      }
    ],
    "devices": [
      {
        "name": "Desktop",
        "viewers": 7
      }
    ],
    "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": "2022-01-26T12:04:00Z",
        "viewers": 7
      }
    ],
    "time_zone": "America/New_York"
  },
  "limits": {
    "from": "2024-03-14T10:31:54.000Z",
    "to": "2024-04-13T10:31:54.000Z"
  }
}