List session users QoS Summary
GET {{baseUrl}}/videosdk/sessions/:sessionId/users/qos_summary?page_size=1&next_page_token=<string>
Use this API to return a list of users from past sessions and a summary of their quality of service received during the session. The data returned indicates the connection quality for sending and receiving video, audio, and shared content. Note: This API may return empty values for users' Prerequisites:
* A Business or a higher plan.
* Developers must subscribe to the QSS summary event to receive data from this API. Scopes: Rate Limit Label: name responses when the account calling this API:
* Does not have a signed HIPAA business associate agreement (BAA).
* Is a legacy HIPAA BAA account.
* Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. dashboard_meetings:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
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
| {
"next_page_token": "<string>",
"page_size": 30,
"users": [
{
"id": "<string>",
"name": "<string>",
"user_key": "<string>",
"qos": [
{
"type": "audio_device_from_crc",
"details": {
"min_bitrate": "<string>",
"avg_bitrate": "<string>",
"max_bitrate": "<string>",
"min_latency": "<string>",
"avg_latency": "<string>",
"max_latency": "<string>",
"min_jitter": "<string>",
"avg_jitter": "<string>",
"max_jitter": "<string>",
"min_loss": "<string>",
"avg_loss": "<string>",
"max_loss": "<string>",
"resolution": "<string>",
"min_frame_rate": "<string>",
"avg_frame_rate": "<string>",
"max_frame_rate": "<string>",
"zoom_min_cpu_usage": "<string>",
"zoom_avg_cpu_usage": "<string>",
"zoom_max_cpu_usage": "<string>",
"system_max_cpu_usage": "<string>"
}
},
{
"type": "video_device_to_crc",
"details": {
"min_bitrate": "<string>",
"avg_bitrate": "<string>",
"max_bitrate": "<string>",
"min_latency": "<string>",
"avg_latency": "<string>",
"max_latency": "<string>",
"min_jitter": "<string>",
"avg_jitter": "<string>",
"max_jitter": "<string>",
"min_loss": "<string>",
"avg_loss": "<string>",
"max_loss": "<string>",
"resolution": "<string>",
"min_frame_rate": "<string>",
"avg_frame_rate": "<string>",
"max_frame_rate": "<string>",
"zoom_min_cpu_usage": "<string>",
"zoom_avg_cpu_usage": "<string>",
"zoom_max_cpu_usage": "<string>",
"system_max_cpu_usage": "<string>"
}
}
]
},
{
"id": "<string>",
"name": "<string>",
"user_key": "<string>",
"qos": [
{
"type": "video_input",
"details": {
"min_bitrate": "<string>",
"avg_bitrate": "<string>",
"max_bitrate": "<string>",
"min_latency": "<string>",
"avg_latency": "<string>",
"max_latency": "<string>",
"min_jitter": "<string>",
"avg_jitter": "<string>",
"max_jitter": "<string>",
"min_loss": "<string>",
"avg_loss": "<string>",
"max_loss": "<string>",
"resolution": "<string>",
"min_frame_rate": "<string>",
"avg_frame_rate": "<string>",
"max_frame_rate": "<string>",
"zoom_min_cpu_usage": "<string>",
"zoom_avg_cpu_usage": "<string>",
"zoom_max_cpu_usage": "<string>",
"system_max_cpu_usage": "<string>"
}
},
{
"type": "video_output",
"details": {
"min_bitrate": "<string>",
"avg_bitrate": "<string>",
"max_bitrate": "<string>",
"min_latency": "<string>",
"avg_latency": "<string>",
"max_latency": "<string>",
"min_jitter": "<string>",
"avg_jitter": "<string>",
"max_jitter": "<string>",
"min_loss": "<string>",
"avg_loss": "<string>",
"max_loss": "<string>",
"resolution": "<string>",
"min_frame_rate": "<string>",
"avg_frame_rate": "<string>",
"max_frame_rate": "<string>",
"zoom_min_cpu_usage": "<string>",
"zoom_avg_cpu_usage": "<string>",
"zoom_max_cpu_usage": "<string>",
"system_max_cpu_usage": "<string>"
}
}
]
}
]
} |
ENDPOINTS