Get webinar participant QoS
GET {{baseUrl}}/metrics/webinars/:webinarId/participants/:participantId/qos?type=live
Return the quality of service (QoS) for participants during live or past webinars. This 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 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.
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'
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, such as external users, unless they meet certain conditions. See
Email address display rules
for details.
Prerequisites:
- A Business, Education, or API Plan with Zoom Rooms set up.
Scopes:
dashboard_webinars:read:admin
,
dashboard:read:admin
Rate Limit Label
:
HEAVY
Request Params
| Key | Datatype | Required | Description |
| type | string | | The type of webinar to query.
past- All past webinars.live- All live webinars.
This value defaults to live. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"id":"\u003cstring\u003e","device":"iOS","domain":"\u003cstring\u003e","harddisk_id":"\u003cstring\u003e","internal_ip_addresses":["\u003cstring\u003e","\u003cstring\u003e"],"ip_address":"\u003cstring\u003e","join_time":"\u003cdateTime\u003e","leave_time":"\u003cdateTime\u003e","location":"\u003cstring\u003e","mac_addr":"\u003cstring\u003e","pc_name":"\u003cstring\u003e","user_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e","user_qos":[{"as_device_from_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_device_to_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_input":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_output":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"audio_device_from_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"audio_device_to_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"audio_input":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"audio_output":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"cpu_usage":{"system_max_cpu_usage":"\u003cstring\u003e","zoom_avg_cpu_usage":"\u003cstring\u003e","zoom_max_cpu_usage":"\u003cstring\u003e","zoom_min_cpu_usage":"\u003cstring\u003e"},"date_time":"\u003cdateTime\u003e","video_device_from_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"video_device_to_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"video_input":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"video_output":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_device_from_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_device_to_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"audio_device_from_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"audio_device_to_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"video_device_from_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"video_device_to_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"wifi_rssi":{"max_rssi":"\u003cinteger\u003e","avg_rssi":"\u003cinteger\u003e","min_rssi":"\u003cinteger\u003e","rssi_unit":"\u003cstring\u003e"}},{"as_device_from_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_device_to_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_input":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_output":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"audio_device_from_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"audio_device_to_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"audio_input":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"audio_output":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"cpu_usage":{"system_max_cpu_usage":"\u003cstring\u003e","zoom_avg_cpu_usage":"\u003cstring\u003e","zoom_max_cpu_usage":"\u003cstring\u003e","zoom_min_cpu_usage":"\u003cstring\u003e"},"date_time":"\u003cdateTime\u003e","video_device_from_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"video_device_to_crc":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"video_input":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"video_output":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_device_from_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"as_device_to_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"audio_device_from_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"audio_device_to_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e"},"video_device_from_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"video_device_to_rwg":{"avg_loss":"\u003cstring\u003e","bitrate":"\u003cstring\u003e","jitter":"\u003cstring\u003e","latency":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","frame_rate":"\u003cstring\u003e","resolution":"\u003cstring\u003e"},"wifi_rssi":{"max_rssi":"\u003cinteger\u003e","avg_rssi":"\u003cinteger\u003e","min_rssi":"\u003cinteger\u003e","rssi_unit":"\u003cstring\u003e"}}],"version":"\u003cstring\u003e"}