Zoom Public API Documentation

List meeting participants QoS

GET {{baseUrl}}/metrics/meetings/:meetingId/participants/qos?type=live&page_size=1&next_page_token=<string>

Show a list of meeting participants from live or past meetings, and their quality of service received during the meeting. The data returned indicates the connection quality for sending or receiving video, audio, and shared content.

Note:

This API may return empty values for participants' 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.

Prerequisites: * A Business or a higher plan.

Scopes: dashboard_meetings:read:admin,dashboard:read:admin

Rate Limit Label: HEAVY

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`.
page_size	number		The number of items returned per page.
next_page_token	string		Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.

HEADERS

Key	Datatype	Required	Description
Accept	string

RESPONSES

status OK

{ "next_page_token": "<string>", "page_count": "<long>", "page_size": 1, "total_records": "<long>", "participants": [ { "id": "<string>", "device": "H.323/SIP", "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>" }, { "id": "<string>", "device": "iOS", "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/qos?type=live&page_size=1&next_page_token=<string>?type=live&page_size=1&next_page_token=<string>' -H 'Accept: application/json'

Ask Qodex
Introduction
FAQs
More
Github
Developer Website
Claim this page
Report this page

ENDPOINTS