Fetch viewer analytics data for a live stream
GET {{baseUrl}}/analytics/viewers/live_streams/:id
(Available from version 1.11) This operation returns the live and historic viewer data for a specific live stream. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data.
Querying live data
- To get data for currently live streams, do not send from and to values.
- 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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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 doesn't include minutes and seconds. If you include minutes and seconds, Wowza Video rounds up to the nearest hour when it is more than 30 minutes. If it is less than 30 minutes, Wowza Video rounds it down to the nearest hour. The maximum difference between from and to is 90 days. If you set the from query parameter without setting the to query parameter, the data returned will reflect 90 days starting at the from date, or data up to to the current day, whichever is shorter.
Example:
2023-01-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 doesn't include minutes and seconds. If you include minutes and seconds, Wowza Video rounds up to the nearest hour when it is more than 30 minutes. If it is less than 30 minutes, Wowza Video rounds it down to the nearest hour. The maximum difference between from and to is 90 days. If you set the to query parameter without setting the from query parameter, the data returned will be from the past 90 days or from your last invoice date, whichever is shorter.
Example:
2023-02-14T10: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 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"live_stream":{"id":"tvctq36g","viewers":7,"countries":[{"code":"US","viewers":4},{"code":"DE","viewers":3}],"renditions":[{"name":720,"viewers":7}],"devices":[{"name":"Desktop","viewers":7}],"trend":[{"sampled_at":"2023-05-26T12:01:00Z","viewers":7},{"sampled_at":"2023-05-26T12:02:00Z","viewers":7},{"sampled_at":"2022-01-26T12:03:00Z","viewers":7},{"sampled_at":"2022-01-26T12:04:00Z","viewers":7},{"sampled_at":"2022-01-26T12:05:00Z","viewers":7},{"sampled_at":"2022-01-26T12:06:00Z","viewers":7},{"sampled_at":"2022-01-26T12:07:00Z","viewers":7},{"sampled_at":"2022-01-26T12:08:00Z","viewers":7},{"sampled_at":"2022-01-26T12:09:00Z","viewers":7},{"sampled_at":"2022-01-26T12:10:00Z","viewers":7},{"sampled_at":"2022-01-26T12:11:00Z","viewers":7},{"sampled_at":"2022-01-26T12:12:00Z","viewers":7},{"sampled_at":"2022-01-26T12:13:00Z","viewers":7},{"sampled_at":"2022-01-26T12:14:00Z","viewers":7},{"sampled_at":"2022-01-26T12:15:00Z","viewers":7},{"sampled_at":"2022-01-26T12:16:00Z","viewers":7},{"sampled_at":"2022-01-26T12:17:00Z","viewers":7},{"sampled_at":"2022-01-26T12:18:00Z","viewers":7},{"sampled_at":"2022-01-26T12:19:00Z","viewers":7},{"sampled_at":"2022-01-26T12:20:00Z","viewers":7},{"sampled_at":"2022-01-26T12:21:00Z","viewers":7},{"sampled_at":"2022-01-26T12:22:00Z","viewers":7},{"sampled_at":"2022-01-26T12:23:00Z","viewers":7},{"sampled_at":"2022-01-26T12:24:00Z","viewers":7},{"sampled_at":"2022-01-26T12:25:00Z","viewers":7},{"sampled_at":"2022-01-26T12:26:00Z","viewers":7},{"sampled_at":"2022-01-26T12:27:00Z","viewers":7},{"sampled_at":"2022-01-26T12:28:00Z","viewers":7},{"sampled_at":"2022-01-26T12:29:00Z","viewers":7},{"sampled_at":"2022-01-26T12:30:00Z","viewers":7},{"sampled_at":"2022-01-26T12:31:00Z","viewers":7},{"sampled_at":"2022-01-26T12:32:00Z","viewers":7},{"sampled_at":"2022-01-26T12:33:00Z","viewers":7},{"sampled_at":"2022-01-26T12:34:00Z","viewers":7},{"sampled_at":"2022-01-26T12:35:00Z","viewers":7},{"sampled_at":"2022-01-26T12:36:00Z","viewers":7},{"sampled_at":"2022-01-26T12:37:00Z","viewers":7},{"sampled_at":"2022-01-26T12:38:00Z","viewers":7},{"sampled_at":"2022-01-26T12:39:00Z","viewers":7},{"sampled_at":"2022-01-26T12:40:00Z","viewers":7},{"sampled_at":"2022-01-26T12:41:00Z","viewers":7},{"sampled_at":"2022-01-26T12:42:00Z","viewers":7},{"sampled_at":"2022-01-26T12:43:00Z","viewers":7},{"sampled_at":"2022-01-26T12:44:00Z","viewers":7},{"sampled_at":"2022-01-26T12:45:00Z","viewers":7},{"sampled_at":"2022-01-26T12:46:00Z","viewers":7},{"sampled_at":"2022-01-26T12:47:00Z","viewers":7},{"sampled_at":"2022-01-26T12:48:00Z","viewers":7},{"sampled_at":"2022-01-26T12:49:00Z","viewers":7},{"sampled_at":"2022-01-26T12:50:00Z","viewers":7},{"sampled_at":"2022-01-26T12:51:00Z","viewers":7},{"sampled_at":"2022-01-26T12:52:00Z","viewers":7},{"sampled_at":"2022-01-26T12:53:00Z","viewers":7},{"sampled_at":"2022-01-26T12:54:00Z","viewers":7},{"sampled_at":"2022-01-26T12:55:00Z","viewers":7},{"sampled_at":"2022-01-26T12:56:00Z","viewers":7},{"sampled_at":"2022-01-26T12:57:00Z","viewers":7},{"sampled_at":"2022-01-26T12:58:00Z","viewers":7},{"sampled_at":"2022-01-26T12:59:00Z","viewers":7},{"sampled_at":"2022-01-26T12:60:00Z","viewers":7}]},"limits":{"from":"2023-04-14T10:31:54.486Z","to":"2023-07-13T10:31:54.486Z"}}