(Available from version 1.11) This operation returns live and historic viewer data for the account related to the JSON web token used for API authentication. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data.
Querying live data
If you don't send any query parameters (to, from, or include), the total number of viewers is returned.
Querying historic 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:
Success
object (account) | |||||||||||||||
| |||||||||||||||
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/account?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices"
{- "account": {
- "viewers": 7,
- "countries": [
- {
- "code": "US",
- "viewers": 4
}, - {
- "code": "DE",
- "viewers": 3
}
], - "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
}
]
}, - "limits": {
- "from": "2024-03-14T10:31:54.000Z",
- "to": "2024-04-13T10:31:54.000Z"
}
}(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
If you don't send any query parameters (to, from, or include), the total number of viewers is returned.
Querying historic 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:
| from | string <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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to | string <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 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
Default: Example: |
Success
object (live_stream) | |||||||||||||||||
| |||||||||||||||||
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/live_streams/tvctq36g?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices"
{- "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
}
], - "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
}
]
}, - "limits": {
- "from": "2024-03-14T10:31:54.000Z",
- "to": "2024-04-13T10:31:54.000Z"
}
}(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
If you don't send any query parameters (to, from, or include), the total number of viewers is returned.
Querying historic 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:
| from | string <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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to | string <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 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
Default: Example: |
Success
object (vod_stream) | |||||||||||||||||
| |||||||||||||||||
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/vod_streams/tvctq36g?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices"
{- "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
}
], - "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
}
]
}, - "limits": {
- "from": "2024-03-14T10:31:54.000Z",
- "to": "2024-04-13T10:31:54.000Z"
}
}(Available from version 1.11) This operation returns the live and historic viewer data for a specific stream target. You'll use the query parameters to return live vs historic data, as well as specific types of viewer data.
Querying live data
If you don't send any query parameters (to, from, or include), the total number of viewers is returned.
Querying historic 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:
| from | string <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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to | string <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 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
Default: Example: |
Success
object (stream_target) | |||||||||||||||||
| |||||||||||||||||
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/stream_targets/tvctq36g?from=2024-03-14T10:31:54.486Z&to=2024-04-13T10:31:54.486Z&include=countries,renditions,devices"
{- "stream_target": {
- "id": "tvctq36g",
- "viewers": 7,
- "countries": [
- {
- "code": "US",
- "viewers": 4
}, - {
- "code": "DE",
- "viewers": 3
}
], - "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
}
]
}, - "limits": {
- "from": "2024-03-14T10:31:54.000Z",
- "to": "2024-04-13T10:31:54.000Z"
}
}(Available from version 1.11) This operation returns viewer data for the top 100 live streams in an account.
Querying data
To get viewer data for the top 100 streams that ran previously, send from and to values.
If you do not send from and to values, the last five minutes' worth of live stream viewer data is returned.
If the time range between from and to query parameters is:
| from | string <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: 2023-01-14T10:31:54.486Z |
| to | string <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 or from your last invoice date, whichever is shorter. Example: 2023-02-14T10:31:54.486Z |
Success
required | Array of objects (live_streams) |
object The time frame represented in the response. |
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/live_streams?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z"
{- "live_streams": [
- {
- "id": "4Jjzstdt",
- "viewers": 3
}, - {
- "id": "fFWxVsyj",
- "viewers": 4
}
], - "limits": {
- "from": "2023-04-14T10:31:54.000Z",
- "to": "2023-07-13T10:31:54.000Z"
}
}(Available from version 1.11) This operation returns viewer data for the top 100 VOD streams in an account.
Querying data
To get viewer data for the top 100 streams that ran previously, send from and to values.
If you do not send from and to values, the last five minutes' worth of VOD stream viewer data is returned.
If the time range between from and to query parameters is:
| from | string <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: 2023-01-14T10:31:54.486Z |
| to | string <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 or from your last invoice date, whichever is shorter. Example: 2023-02-14T10:31:54.486Z |
Success
required | Array of objects (vod_streams) |
object The time frame represented in the response. |
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/vod_streams?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z"
{- "vod_streams": [
- {
- "id": "4Jjzstdt",
- "viewers": 3
}, - {
- "id": "fFWxVsyj",
- "viewers": 4
}
], - "limits": {
- "from": "2023-04-14T10:31:54.000Z",
- "to": "2023-07-13T10:31:54.000Z"
}
}(Available from version 2.0) This operation returns the total viewers data for the account related to the JSON web token used for API authentication.
Querying data
Use the include query parameter to specify what data you want to return, including: countries, renditions, and devices.
If you don't send the include query parameter, the total number of viewers is returned.
| 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, and devices. Example: countries | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| time_zone | string Specify the time zone you want the returned data to reflect. Click to expand for the full list of valid values
Default: Example: |
Success
object (account) | |||||||||||||
| |||||||||||||
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/account/total?include=countries,renditions,devices"
{- "account": {
- "viewers": 7,
- "countries": [
- {
- "code": "US",
- "viewers": 4
}, - {
- "code": "DE",
- "viewers": 3
}
], - "renditions": [
- {
- "name": 720,
- "viewers": 7
}
], - "devices": [
- {
- "name": "Desktop",
- "viewers": 7
}
], - "time_zone": "America/New_York"
}, - "limits": {
- "from": "2024-04-01T00:00:00.000Z",
- "to": "2024-04-09T14:20:03.000Z"
}
}(Available from version 2.0) This operation returns the total viewers data for a specific live stream.
Querying data
Use the include query parameter to specify what data you want to return, including: countries, renditions, and devices.
If you don't send the include query parameter, the total number of viewers is returned.
| 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, and devices. Example: countries | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| time_zone | string Specify the time zone you want the returned data to reflect. Click to expand for the full list of valid values
Default: Example: |
Success
object (live_stream) | |||||||||||||||
| |||||||||||||||
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/live_streams/tvctq36g/total?include=countries,renditions,devices"
{- "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
}
], - "time_zone": "America/New_York"
}, - "limits": {
- "from": "2024-04-01T00:00:00.000Z",
- "to": "2024-04-09T14:20:03.000Z"
}
}(Available from version 2.0) This operation returns the total viewers data for a specific VOD stream.
Querying data
Use the include query parameter to specify what data you want to return, including: countries, renditions, and devices.
If you don't send the include query parameter, the total number of viewers is returned.
| 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, and devices. Example: countries | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| time_zone | string Specify the time zone you want the returned data to reflect. Click to expand for the full list of valid values
Default: Example: |
Success
object (vod_stream) | |||||||||||||||
| |||||||||||||||
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/vod_streams/tvctq36g/total?include=countries,renditions,devices"
{- "vod_stream": {
- "id": "tvctq36g",
- "viewers": 7,
- "countries": [
- {
- "code": "US",
- "viewers": 4
}, - {
- "code": "DE",
- "viewers": 3
}
], - "renditions": [
- {
- "name": 720,
- "viewers": 7
}
], - "devices": [
- {
- "name": "Desktop",
- "viewers": 7
}
], - "time_zone": "America/New_York"
}, - "limits": {
- "from": "2024-04-01T00:00:00.000Z",
- "to": "2024-04-09T14:20:03.000Z"
}
}(Available from version 2.0) This operation returns the total viewers data for a specific stream target.
Querying data
Use the include query parameter to specify what data you want to return, including: countries, renditions, and devices.
If you don't send the include query parameter, the total number of viewers is returned.
| 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, and devices. Example: countries | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| time_zone | string Specify the time zone you want the returned data to reflect. Click to expand for the full list of valid values
Default: Example: |
Success
object (stream_target) | |||||||||||||||
| |||||||||||||||
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v2.0/analytics/viewers/stream_targets/tvctq36g/total?include=countries,renditions,devices"
{- "stream_target": {
- "id": "tvctq36g",
- "viewers": 7,
- "countries": [
- {
- "code": "US",
- "viewers": 4
}, - {
- "code": "DE",
- "viewers": 3
}
], - "renditions": [
- {
- "name": 720,
- "viewers": 7
}
], - "devices": [
- {
- "name": "Desktop",
- "viewers": 7
}
], - "time_zone": "America/New_York"
}, - "limits": {
- "from": "2024-06-01T00:00:00.000Z",
- "to": "2024-04-09T14:20:03.000Z"
}
}