List webinar participants QoS Summary
GET {{baseUrl}}/metrics/webinars/:webinarId/participants/qos_summary?page_size=1&next_page_token=<string>
Use this API to return a list of webinar participants from live or past webinars and the quality of service they received during the webinar. The data returned indicates the connection quality for sending/receiving video, audio, and shared content.
Note:
This API may return empty values for participants'
user_name
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, Education, or API Plan with Webinar add-on.
- Developers must subscribe to the QSS summary event to receive data from this API.
Scopes:
dashboard_webinars:read:admin
Rate Limit Label
:
Heavy
Request Params
| 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":"\u003cstring\u003e","page_size":30,"participants":[{"id":"\u003cstring\u003e","participant_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e","email":"\u003cemail\u003e","qos":[{"type":"audio_device_to_crc","details":{"min_bitrate":"\u003cstring\u003e","avg_bitrate":"\u003cstring\u003e","max_bitrate":"\u003cstring\u003e","min_latency":"\u003cstring\u003e","avg_latency":"\u003cstring\u003e","max_latency":"\u003cstring\u003e","min_jitter":"\u003cstring\u003e","avg_jitter":"\u003cstring\u003e","max_jitter":"\u003cstring\u003e","min_loss":"\u003cstring\u003e","avg_loss":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","resolution":"\u003cstring\u003e","min_frame_rate":"\u003cstring\u003e","avg_frame_rate":"\u003cstring\u003e","max_frame_rate":"\u003cstring\u003e","zoom_min_cpu_usage":"\u003cstring\u003e","zoom_avg_cpu_usage":"\u003cstring\u003e","zoom_max_cpu_usage":"\u003cstring\u003e","system_max_cpu_usage":"\u003cstring\u003e"}},{"type":"video_output","details":{"min_bitrate":"\u003cstring\u003e","avg_bitrate":"\u003cstring\u003e","max_bitrate":"\u003cstring\u003e","min_latency":"\u003cstring\u003e","avg_latency":"\u003cstring\u003e","max_latency":"\u003cstring\u003e","min_jitter":"\u003cstring\u003e","avg_jitter":"\u003cstring\u003e","max_jitter":"\u003cstring\u003e","min_loss":"\u003cstring\u003e","avg_loss":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","resolution":"\u003cstring\u003e","min_frame_rate":"\u003cstring\u003e","avg_frame_rate":"\u003cstring\u003e","max_frame_rate":"\u003cstring\u003e","zoom_min_cpu_usage":"\u003cstring\u003e","zoom_avg_cpu_usage":"\u003cstring\u003e","zoom_max_cpu_usage":"\u003cstring\u003e","system_max_cpu_usage":"\u003cstring\u003e"}}]},{"id":"\u003cstring\u003e","participant_id":"\u003cstring\u003e","user_name":"\u003cstring\u003e","email":"\u003cemail\u003e","qos":[{"type":"video_input","details":{"min_bitrate":"\u003cstring\u003e","avg_bitrate":"\u003cstring\u003e","max_bitrate":"\u003cstring\u003e","min_latency":"\u003cstring\u003e","avg_latency":"\u003cstring\u003e","max_latency":"\u003cstring\u003e","min_jitter":"\u003cstring\u003e","avg_jitter":"\u003cstring\u003e","max_jitter":"\u003cstring\u003e","min_loss":"\u003cstring\u003e","avg_loss":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","resolution":"\u003cstring\u003e","min_frame_rate":"\u003cstring\u003e","avg_frame_rate":"\u003cstring\u003e","max_frame_rate":"\u003cstring\u003e","zoom_min_cpu_usage":"\u003cstring\u003e","zoom_avg_cpu_usage":"\u003cstring\u003e","zoom_max_cpu_usage":"\u003cstring\u003e","system_max_cpu_usage":"\u003cstring\u003e"}},{"type":"video_device_from_crc","details":{"min_bitrate":"\u003cstring\u003e","avg_bitrate":"\u003cstring\u003e","max_bitrate":"\u003cstring\u003e","min_latency":"\u003cstring\u003e","avg_latency":"\u003cstring\u003e","max_latency":"\u003cstring\u003e","min_jitter":"\u003cstring\u003e","avg_jitter":"\u003cstring\u003e","max_jitter":"\u003cstring\u003e","min_loss":"\u003cstring\u003e","avg_loss":"\u003cstring\u003e","max_loss":"\u003cstring\u003e","resolution":"\u003cstring\u003e","min_frame_rate":"\u003cstring\u003e","avg_frame_rate":"\u003cstring\u003e","max_frame_rate":"\u003cstring\u003e","zoom_min_cpu_usage":"\u003cstring\u003e","zoom_avg_cpu_usage":"\u003cstring\u003e","zoom_max_cpu_usage":"\u003cstring\u003e","system_max_cpu_usage":"\u003cstring\u003e"}}]}]}