Zoom Public API Documentation
List session users QoS
GET {{baseUrl}}/videosdk/sessions/:sessionId/users/qos?type=live&page_size=10&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82
Use this API to return a list of session users from live or past sessions along with the QoS (quality of service) they received during the session. For example, connection quality for sending and receiving video, audio, and shared content. You can specify a monthly date range for the dashboard data using the Rate Limit Label: Prerequisites:
* A Video SDK Accountfrom and to query parameters. The month should fall within the last six months.
type query parameter, the API defaults to the live value and the API will only return metrics for users in a live session, if a session is currently in progress.past value for the type query parameter.Heavy
Body
PARAM
| Key | Datatype | Required | Description |
type
|
string | The session types: * `past` — A past session. * `live` — A live session. This value defaults to `live`. | |
page_size
|
number | The number of items returned per page. | |
next_page_token
|
string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"page_size": 5,
"next_page_token": "1cyhUewZa419P9F8QUYURck0U3rFWB0d1H2",
"users": [
{
"id": "1670000000",
"name": "User",
"device": "Android",
"ip_address": "192.0.2.0",
"location": "San Jose (US)",
"network_type": "Wifi",
"microphone": "Plantronics BT600",
"speaker": "Plantronics BT600",
"camera": "FaceTime HD Camera",
"data_center": "SC",
"connection_type": "P2P",
"join_time": "2021-12-07T05:42:28Z",
"leave_time": "2021-12-07T05:42:28Z",
"user_qos": [
{
"date_time": "2021-12-07T05:42:28Z",
"audio_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%"
},
"audio_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%"
},
"video_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"video_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"as_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"as_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"cpu_usage": {
"zoom_min_cpu_usage": "8%",
"zoom_avg_cpu_usage": "12%",
"zoom_max_cpu_usage": "18%",
"system_max_cpu_usage": "40%"
}
},
{
"date_time": "2021-12-07T05:42:28Z",
"audio_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%"
},
"audio_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%"
},
"video_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"video_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"as_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"as_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"cpu_usage": {
"zoom_min_cpu_usage": "8%",
"zoom_avg_cpu_usage": "12%",
"zoom_max_cpu_usage": "18%",
"system_max_cpu_usage": "40%"
}
}
]
},
{
"id": "1670000000",
"name": "User",
"device": "Android",
"ip_address": "192.0.2.0",
"location": "San Jose (US)",
"network_type": "Wifi",
"microphone": "Plantronics BT600",
"speaker": "Plantronics BT600",
"camera": "FaceTime HD Camera",
"data_center": "SC",
"connection_type": "P2P",
"join_time": "2021-12-07T05:42:28Z",
"leave_time": "2021-12-07T05:42:28Z",
"user_qos": [
{
"date_time": "2021-12-07T05:42:28Z",
"audio_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%"
},
"audio_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%"
},
"video_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"video_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"as_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"as_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"cpu_usage": {
"zoom_min_cpu_usage": "8%",
"zoom_avg_cpu_usage": "12%",
"zoom_max_cpu_usage": "18%",
"system_max_cpu_usage": "40%"
}
},
{
"date_time": "2021-12-07T05:42:28Z",
"audio_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%"
},
"audio_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%"
},
"video_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"video_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"as_input": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"as_output": {
"bitrate": "23 kbps",
"latency": "126 ms",
"jitter": "6 ms",
"avg_loss": "0.3%",
"max_loss": "1.9%",
"resolution": "1280*720",
"frame_rate": "12 fps"
},
"cpu_usage": {
"zoom_min_cpu_usage": "8%",
"zoom_avg_cpu_usage": "12%",
"zoom_max_cpu_usage": "18%",
"system_max_cpu_usage": "40%"
}
}
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/videosdk/sessions/:sessionId/users/qos?type=live&page_size=10&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82?type=live&page_size=10&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82' -H 'Accept: application/json'
ENDPOINTS