GET {{baseUrl}}/metrics/webinars/:webinarId/participants/qos?type=live&page_size=1&next_page_token=<string>
Show 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' Prerequisites:
* A Business, Education, or API Plan with Webinar add-on. 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, such as external users, unless they meet certain conditions. See Email address display rules for details. dashboard_webinars:read:admin
,dashboard:read:admin
HEAVY
Body
PARAM
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`. | |
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
Curl curl -X GET 'https://api.zoom.us/v2/metrics/webinars/:webinarId/participants/qos?type=live&page_size=1&next_page_token=<string>?type=live&page_size=1&next_page_token=<string>' -H 'Accept: application/json' ENDPOINTS |