Get session user QoS
GET {{baseUrl}}/videosdk/sessions/:sessionId/users/:userId/qos?type=live
Use this API to retrieve the quality of service (QoS) for users from live or past sessions. The data returned indicates the connection quality for sending and receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received.
* This API will not return data if there is no data being sent or received at the time of request. Rate Limit Label: Note: When the sender sends its data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum.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`. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"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%"
}
}
]
} |
ENDPOINTS