(Available from version 2.0) This operation returns the error density metrics for all streams within the account related to the JSON web token used for API authentication.
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/2.0/analytics/qoe/error_density/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend"
{- "account": {
- "error_density": 7,
- "time_zone": "America/New_York",
- "trend": [
- {
- "average": "1.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "0.9829059829059829,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}, - {
- "average": "0.806060606060606,",
- "sampled_at": "2024-09-13T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the error density metrics for specific streams.
| from | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string Specify the data you want returned in the response. Valid value is trend. Example: trend | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices.
Example: Desktop
enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include_recoverable | string Specifies whether recoverable (non-fatal) playback errors should be included in the response. Default is | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (media) | |||||||||
| |||||||||
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/2.0/analytics/qoe/error_density/media/7ced08dd-a744-4944-bb87-019979cb3597?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend"
{- "media": {
- "error_density": 7,
- "time_zone": "America/New_York",
- "trend": [
- {
- "average": "1.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "0.9829059829059829,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}, - {
- "average": "0.806060606060606,",
- "sampled_at": "2024-09-13T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the percentage of error free sessions for all the streams within the account related to the JSON web token used for API authentication.
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The device data you want returned in the response. Valid value is trend. Example: trend | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include_recoverable | boolean Include recoverable errors in the response. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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/2.0/analytics/qoe/error_free_sessions/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "account": {
- "error_free_sessions": 7,
- "time_zone": "America/New_York",
- "trend": [
- {
- "average": "1.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "2.0,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the percentage of sessions that were error-free for specific streams.
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The device data you want returned in the response. Valid value is devices. Example: devices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include_recoverable | boolean Include recoverable errors in the response. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (media) | |||||||||
| |||||||||
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/2.0/analytics/qoe/error_free_sessions/media/abc123?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "media": {
- "error_free_sessions": 7,
- "time_zone": "America/New_York",
- "trend": [
- {
- "average": "1.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "2.0,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns a list of media assets impacted by a specified error, including the number of times each asset was impacted.
| error_code required | any The unique identifier that represents a specific playback error. See this list for all the available error codes in Wowza Flowplayer. Example: 02-37 |
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The device data you want returned in the response. Valid value is devices. Example: devices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| media_ids | string A comma separated list of IDs of the streams you want the returned data to reflect. If media_ids aren't specified, then the pagination parameters, limit and page, are used instead to determine returned results. Example: abcd1234,wxyz3457 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include_recoverable | boolean Include recoverable errors in the response. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer Specify the number of results to return per page. The maximum number of results per page is 20. The default is 10. The minimum value is 1. Example: 15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page | integer Returns a paginated view of results. Specify a positive integer to indicate which page of the results should be displayed. Pagination is determined according to the following logic:
Example: 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
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/2.0/analytics/qoe/errors/detail/media/:error_code/?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "code": "02-01",
- "name": "PlaybackVideoBufferUnderRun",
- "type": "Media",
- "media": [
- {
- "id": "abcd1234",
- "playback_type": "VOD",
- "count": 5
}
], - "limits": {
- "from": "2024-09-08T00:00:00Z",
- "to": "2024-10-08T00:00:00Z",
- "limit": 10,
- "page": 0,
- "max_page": 10
}
}(Available from version 2.0) This operation returns a list of the most frequent error messages associated with a specified error code, including the number of times each message occurred.
| error_code required | any The unique identifier that represents a specific playback error. See this list for all the available error codes in Wowza Flowplayer. Example: 02-37 |
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The device data you want returned in the response. Valid value is devices. Example: devices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| media_ids | string A comma separated list of IDs of the streams you want the returned data to reflect. If media_ids aren't specified, then the pagination parameters, limit and page, are used instead to determine returned results. Example: abcd1234,wxyz3457 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include_recoverable | boolean Include recoverable errors in the response. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer Specify the number of results to return per page. The maximum number of results per page is 20. The default is 10. The minimum value is 1. Example: 15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page | integer Returns a paginated view of results. Specify a positive integer to indicate which page of the results should be displayed. Pagination is determined according to the following logic:
Example: 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
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/2.0/analytics/qoe/errors/detail/message/:error_code/?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "code": "02-01",
- "name": "PlaybackVideoBufferUnderRun",
- "type": "Media",
- "message": [
- {
- "text": "Buffer underrun occurred during playback",
- "count": 7
}
], - "limits": {
- "from": "2024-09-08T00:00:00Z",
- "to": "2024-10-08T00:00:00Z",
- "limit": 10,
- "page": 0,
- "max_page": 10
}
}(Available from version 2.0) This operation returns a list of resource URLs impacted by a specific error code, along with their corresponding occurrence counts.
| error_code required | string The unique identifier that represents a specific playback error. See this list for all the available error codes in Wowza Flowplayer. Example: 02-37 |
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The device data you want returned in the response. Valid value is devices. Example: devices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| media_ids | string A comma separated list of IDs of the streams you want the returned data to reflect. If media_ids aren't specified, then the pagination parameters, limit and page, are used instead to determine returned results. Example: abcd1234,wxyz3457 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include_recoverable | boolean Include recoverable errors in the response. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer Specify the number of results to return per page. The maximum number of results per page is 20. The default is 10. The minimum value is 1. Example: 15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page | integer Returns a paginated view of results. Specify a positive integer to indicate which page of the results should be displayed. Pagination is determined according to the following logic:
Example: 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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
| code | string The error code id. For a full list of the player error codes, see this list. |
object (resource) |
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/2.0/analytics/qoe/errors/detail/resources/:error_code/?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "code": "02-01",
- "name": "PlaybackVideoBufferUnderRun",
- "type": "Playback",
- "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the error drill down by device metrics for all the live streams and videos within the account related to the JSON web token used for API authentication.
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| media_ids | string A comma separated list of IDs of the streams you want the returned data to reflect. If media_ids aren't specified, then the pagination parameters, limit and page, are used instead to determine returned results. Example: abcd1234,wxyz3457 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sort_by | string Specify the metric used to sort the returned objects.
Example: total_count
Enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sort_by_order | string Sort the results in ascending ( | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| error_type | string Filter results by a specific type of error. Example: Playback | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include_recoverable | boolean Include recoverable errors in the response. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer Specify the number of results to return per page. The maximum number of results per page is 20. The default is 10. The minimum value is 1. Example: 15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page | integer Returns a paginated view of results. Specify a positive integer to indicate which page of the results should be displayed. Pagination is determined according to the following logic:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Error) | |
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/2.0/analytics/qoe/errors/drilldown/?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "error": [
- {
- "code": "02-01",
- "avg_retry_count": 0.92,
- "total_count": 10,
- "session_count": 2,
- "name": "PlaybackVideoBufferUnderRun",
- "type": "Playback"
}
], - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z",
- "limit": 10,
- "page": 0,
- "max_page": 0
}
}(Available from version 2.0) This operation returns the errors drill down trend metrics for all the streams within the account related to the JSON web token used for API authentication.
| error_code required | any The unique identifier that represents a specific playback error. See this list for all the available error codes in Wowza Flowplayer. Example: 02-37 |
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The device data you want returned in the response. Valid value is devices. Example: devices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| error_type | string Filter results by a specific type of error. Example: Playback | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include_recoverable | boolean Include recoverable errors in the response. Example: true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| media_ids | string A comma separated list of IDs of the streams you want the returned data to reflect. If media_ids aren't specified, then the pagination parameters, limit and page, are used instead to determine returned results. Example: abcd1234,wxyz3457 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (error) | |||||||||||
| |||||||||||
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/2.0/analytics/qoe/errors/drilldown/trend/02-01?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "error": [
- {
- "code": "02-01",
- "trend": {
- "count": 10,
- "sampled_at": "2024-09-19T00:00:00.000Z"
}, - "name": "PlaybackVideoBufferUnderRun",
- "type": "Playback",
- "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}
]
}(Available from version 2.0) This operation returns the rebuffer count metrics for all the live streams and videos within the account related to the JSON web token used for API authentication.
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The trend data you want returned in the response. Valid value is trend. Example: trend | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. If you want to specify multiple devices, send a comma-separated list of the devices you need the returned data to reflect. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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/2.0/analytics/qoe/rebuffer_count/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "account": {
- "rebuffer_per_view": 0.009584664536741214,
- "time_zone": "Etc/UTC",
- "trend": [
- {
- "average": "0.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "0.01171875,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}, - {
- "average": "0.0,",
- "sampled_at": "2024-09-13T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the rebuffer count metrics for specific live stream(s) and/or video(s).
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The trend data you want returned in the response. Valid value is trend. Example: trend | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. If you want to specify multiple devices, send a comma-separated list of the devices you need the returned data to reflect. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (media) | |||||||||
| |||||||||
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/2.0/analytics/qoe/rebuffer_count/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "media": {
- "rebuffer_per_view": 0,
- "time_zone": "America/New_York",
- "trend": [
- {
- "average": "0.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "0.0,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}, - {
- "average": "0.0,",
- "sampled_at": "2024-09-13T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the rebuffer count drill down metrics for all the live streams and videos within the account related to the JSON web token used for API authentication.
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The device data you want returned in the response. Valid value is devices. Example: devices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| media_ids | string A comma separated list of IDs of the streams you want the returned data to reflect. If media_ids aren't specified, then the pagination parameters, limit and page, are used instead to determine returned results. Example: abcd1234,wxyz3457 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sort_by | string Specify the order of the returned objects. The default is plays. Example: plays Enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer Specify the number of results to return per page. The maximum number of results per page is 20. The default is 10. The minimum value is 1. Example: 15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page | integer Returns a paginated view of results. Specify a positive integer to indicate which page of the results should be displayed. Pagination is determined according to the following logic:
Example: 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Array of media) | |||||||||||||
| |||||||||||||
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/2.0/analytics/qoe/rebuffer_count/drilldown?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z&include=devices';
{- "media": [
- {
- "id": "crtspppp",
- "rebuffer_count": 1.19,
- "plays": 233,
- "playback_type": "vod",
- "devices": [
- {
- "device": "Desktop",
- "plays": 174,
- "rebuffer_count": 1.19
}, - {
- "device": "Tablet",
- "plays": 59,
- "rebuffer_count": 1.19
}
]
}
], - "limits": {
- "from": "2025-09-08T14:35:00Z",
- "to": "2025-10-08T14:35:00Z",
- "page": 0,
- "limit": 10,
- "max_page": 7,
- "sort_by": "metric",
- "sort_by_order": "desc"
}
}(Available from version 2.0) This operation returns rebuffer count drill down trend metrics for specific live streams and/or videos.
| ids required | any The unique alphanumeric string that identifies the live stream or video. Send a comma-separated list of live stream and/or video ids to request trended rebuffer count drill down metrics for specific live streams and/or videos. Note: You can send up to 5 IDs in the request. If you send more than 5 IDs, only the first 5 IDs will be considered and the rest are ignored. schema: type: string |
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Array of media) | |||||||
| |||||||
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/2.0/analytics/qoe/rebuffer_count/drilldown_trend/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z';
{- "media": [
- {
- "id": "62588c40-9326-4a98-8836-a347bdad6e5b",
- "trend": [
- {
- "sampled_at": "2024-10-08T14:35:00Z",
- "rebuffer_count": 1.19
}, - {
- "sampled_at": "2024-10-08T14:35:00Z",
- "rebuffer_count": 1.19
}
]
}
], - "limits": {
- "from": "2024-09-08T14:35:00Z",
- "to": "2024-10-08T14:35:00Z"
}
}(Available from version 2.0) This operation returns the rebuffer time for all the live streams and videos within the account related to the JSON web token used for API authentication.
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The trend data you want returned in the response. Valid value is trend. Example: trend | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. If you want to specify multiple devices, send a comma-separated list of the devices you need the returned data to reflect. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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/2.0/analytics/qoe/rebuffer_time/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "account": {
- "rebuffer_time": 165.99156363636365,
- "time_zone": "Etc/UTC",
- "trend": [
- {
- "average": "0.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "165.99156363636365,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}, - {
- "average": "0.0,",
- "sampled_at": "2024-09-13T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the rebuffer time metrics for specific live stream(s) and/or video(s).
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The trend data you want returned in the response. Valid value is trend. Example: trend | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. If you want to specify multiple devices, send a comma-separated list of the devices you need the returned data to reflect. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (media) | |||||||||
| |||||||||
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/2.0/analytics/qoe/rebuffer_time/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "media": {
- "rebuffer_time": 1.71232543562145,
- "time_zone": "America/New_York",
- "trend": [
- {
- "average": "1.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "1.9829059829059829,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}, - {
- "average": "1.806060606060606,",
- "sampled_at": "2024-09-13T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the rebuffer time drill down metrics for all the live streams and videos within the account related to the JSON web token used for API authentication.
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The device data you want returned in the response. Valid value is devices. Example: devices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| media_ids | string A comma separated list of IDs of the streams you want the returned data to reflect. If media_ids aren't specified, then the pagination parameters, limit and page, are used instead to determine returned results. Example: abcd1234,wxyz3457 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sort_by | string Specify the order of the returned objects. The default is plays. Example: plays Enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer Specify the number of results to return per page. The maximum number of results per page is 20. The default is 10. The minimum value is 1. Example: 15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page | integer Returns a paginated view of results. Specify a positive integer to indicate which page of the results should be displayed. Pagination is determined according to the following logic:
Example: 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Array of media) | |||||||||||||
| |||||||||||||
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/2.0/analytics/qoe/rebuffer_time/drilldown?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z&include=devices';
{- "media": [
- {
- "id": "crtspppp",
- "rebuffer_time": 1.19,
- "plays": 233,
- "playback_type": "vod",
- "devices": [
- {
- "device": "Desktop",
- "plays": 174,
- "rebuffer_time": 1.19
}, - {
- "device": "Tablet",
- "plays": 59,
- "rebuffer_time": 1.19
}
]
}
], - "limits": {
- "from": "2024-09-08T14:35:00Z",
- "to": "2024-10-08T14:35:00Z",
- "page": 0,
- "limit": 10,
- "max_page": 7,
- "sort_by": "metric",
- "sort_by_order": "desc"
}
}(Available from version 2.0) This operation returns rebuffer time drill down trend metrics for specific live streams and/or videos.
| ids required | string The unique alphanumeric string that identifies the live stream or video. Send a comma-separated list of live stream and/or video ids to request trended rebuffer time drill down metrics for specific live streams and/or videos. Note: You can send up to 5 IDs in the request. If you send more than 5 IDs, only the first 5 IDs will be considered and the rest are ignored. |
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Array of media) | |||||||
| |||||||
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/2.0/analytics/qoe/rebuffer_count/drilldown_trend/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z';
{- "media": [
- {
- "id": "62588c40-9326-4a98-8836-a347bdad6e5b",
- "trend": [
- {
- "sampled_at": "2024-10-08T14:35:00Z",
- "rebuffer_time": 1.19
}, - {
- "sampled_at": "2024-10-08T14:35:00Z",
- "rebuffer_time": 1.19
}
]
}
], - "limits": {
- "from": "2024-09-08T14:35:00Z",
- "to": "2024-10-08T14:35:00Z"
}
}(Available from version 2.0) This operation returns the video start time metrics for all the live streams, real-time streams, and videos within the account related to the JSON web token used for API authentication.
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The trend data you want returned in the response. Valid value is trend. Example: trend | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. If you want to specify multiple devices, send a comma-separated list of the devices you need the returned data to reflect. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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/2.0/analytics/qoe/video_start_time/account?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "account": {
- "average": 400.64516129032256,
- "time_zone": "Etc/UTC",
- "quantile_25": 300,
- "quantile_50": 300,
- "quantile_75": 300,
- "quantile_95": 1206,
- "quantile_99": 3390,
- "trend": [
- {
- "average": "0.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "525.0,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}, - {
- "average": "382.0,",
- "sampled_at": "2024-09-13T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the video start time metrics for specific live stream(s), real-time stream(s), and/or video(s).
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54.486Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The trend data you want returned in the response. Valid value is trend. Example: trend | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. If you want to specify multiple devices, send a comma-separated list of the devices you need the returned data to reflect. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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/2.0/analytics/qoe/video_start_time/media/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2024-09-08T14:35:00.486Z&to=2024-10-08T14:35:00.486Z&devices=Desktop&include=trend';
{- "media": {
- "average": 400.64516129032256,
- "time_zone": "Etc/UTC",
- "quantile_25": 300,
- "quantile_50": 300,
- "quantile_75": 300,
- "quantile_95": 1206,
- "quantile_99": 3390,
- "trend": [
- {
- "average": "0.0,",
- "sampled_at": "2024-09-08T00:00:00.000Z"
}, - {
- "average": "525.0,",
- "sampled_at": "2024-09-11T00:00:00.000Z"
}, - {
- "average": "382.0,",
- "sampled_at": "2024-09-13T00:00:00.000Z"
}
]
}, - "limits": {
- "from": "2024-09-08T14:35:00.000Z",
- "to": "2024-10-08T14:35:00.000Z"
}
}(Available from version 2.0) This operation returns the video start time drill down metrics for all the live streams, real-time streams, and videos within the account related to the JSON web token used for API authentication.
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| include | string The device data you want returned in the response. Valid value is devices. Example: devices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| media_ids | string A comma separated list of IDs of the streams you want the returned data to reflect. If media_ids aren't specified, then the pagination parameters, limit and page, are used instead to determine returned results. Example: abcd1234,wxyz3457 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| sort_by | string Specify the order of the returned objects. The default is plays. Example: plays Enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer Specify the number of results to return per page. The maximum number of results per page is 20. The default is 10. The minimum value is 1. Example: 15 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| page | integer Returns a paginated view of results. Specify a positive integer to indicate which page of the results should be displayed. Pagination is determined according to the following logic:
Example: 2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Array of media) | |||||||||||||
| |||||||||||||
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/2.0/analytics/qoe/video_start_time/drilldown?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z&include=devices';
{- "media": [
- {
- "id": "crtspppp",
- "video_start_time": 1.19,
- "plays": 233,
- "playback_type": "vod",
- "devices": [
- {
- "device": "Desktop",
- "plays": 174,
- "video_start_time": 1.19
}, - {
- "device": "Tablet",
- "plays": 59,
- "video_start_time": 1.19
}
]
}
], - "limits": {
- "from": "2024-09-08T14:35:00Z",
- "to": "2024-10-08T14:35:00Z",
- "page": 0,
- "limit": 10,
- "max_page": 7,
- "sort_by": "metric",
- "sort_by_order": "desc"
}
}(Available from version 2.0) This operation returns video start time drill down trend metrics for specific live streams, real-time streams, and/or videos.
| ids required | string A unique alphanumeric ID for a live stream, real-time stream, or video. Use a comma-separated list of these IDs to request trended video start time drilldown metrics. Note: You can send up to 5 IDs in the request. If you send more than 5 IDs, only the first 5 IDs will be considered and the rest are ignored. |
| from required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| to required | string <date-time> 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. Example: 2024-03-14T10:31:54Z | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| devices | string Specify the devices you want the returned data to reflect. If you don't specify a device, the returned data includes all the playback devices. Example: Desktop enum: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 (Array of media) | |||||||
| |||||||
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/2.0/analytics/qoe/video_start_time/drilldown_trend/7ced08dd-a744-4944-bb87-019979cb3597,6fa964ce-9515-4001-ae72-f17ae52dbf6c?from=2025-01-08T14:35:00Z&to=2025-02-08T14:35:00Z';
{- "media": [
- {
- "id": "62588c40-9326-4a98-8836-a347bdad6e5b",
- "trend": [
- {
- "sampled_at": "2024-10-08T14:35:00Z",
- "video_start_time": 1.19
}, - {
- "sampled_at": "2024-10-08T14:35:00Z",
- "video_start_time": 1.19
}
]
}
], - "limits": {
- "from": "2024-09-08T14:35:00Z",
- "to": "2024-10-08T14:35:00Z"
}
}