Zoom Public API Documentation
Get meeting participant QoS
GET {{baseUrl}}/metrics/meetings/:meetingId/participants/:participantId/qos?type=live
Return the quality of service (QoS) report for participants from live or past meetings. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. When the sender sends 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. This API will not return data if there is no data being sent or received at the time of request. Note: This API may return empty values for participants' Scopes: Rate Limit Label: user_name, ip_address, location, and email 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. See Email address display rules for details. dashboard_meetings:read:admin,dashboard:read:adminHEAVY
Body
PARAM
| Key | Datatype | Required | Description |
type
|
string | The type of meeting to query. * `past` - All past meetings. * `live` - All live meetings. This value defaults to `live`. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"id": "<string>",
"device": "Mac",
"domain": "<string>",
"harddisk_id": "<string>",
"internal_ip_addresses": [
"<string>",
"<string>"
],
"ip_address": "<string>",
"join_time": "<dateTime>",
"leave_time": "<dateTime>",
"location": "<string>",
"mac_addr": "<string>",
"pc_name": "<string>",
"user_id": "<string>",
"user_name": "<string>",
"user_qos": [
{
"as_device_from_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_device_to_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_input": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_output": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"audio_device_from_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"audio_device_to_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"audio_input": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"audio_output": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"cpu_usage": {
"system_max_cpu_usage": "<string>",
"zoom_avg_cpu_usage": "<string>",
"zoom_max_cpu_usage": "<string>",
"zoom_min_cpu_usage": "<string>"
},
"date_time": "<dateTime>",
"video_device_from_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"video_device_to_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"video_input": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"video_output": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_device_from_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_device_to_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"audio_device_from_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"audio_device_to_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"video_device_from_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"video_device_to_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"wifi_rssi": {
"max_rssi": "<integer>",
"avg_rssi": "<integer>",
"min_rssi": "<integer>",
"rssi_unit": "<string>"
}
},
{
"as_device_from_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_device_to_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_input": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_output": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"audio_device_from_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"audio_device_to_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"audio_input": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"audio_output": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"cpu_usage": {
"system_max_cpu_usage": "<string>",
"zoom_avg_cpu_usage": "<string>",
"zoom_max_cpu_usage": "<string>",
"zoom_min_cpu_usage": "<string>"
},
"date_time": "<dateTime>",
"video_device_from_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"video_device_to_crc": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"video_input": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"video_output": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_device_from_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"as_device_to_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"audio_device_from_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"audio_device_to_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>"
},
"video_device_from_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"video_device_to_rwg": {
"avg_loss": "<string>",
"bitrate": "<string>",
"jitter": "<string>",
"latency": "<string>",
"max_loss": "<string>",
"frame_rate": "<string>",
"resolution": "<string>"
},
"wifi_rssi": {
"max_rssi": "<integer>",
"avg_rssi": "<integer>",
"min_rssi": "<integer>",
"rssi_unit": "<string>"
}
}
],
"version": "<string>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/metrics/meetings/:meetingId/participants/:participantId/qos?type=live?type=live' -H 'Accept: application/json'
ENDPOINTS