Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs
Account Events
App Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Data Compliance
get

/metrics/webinars/{webinarId}/participants/qos

Retrieve a list of participants from live or past webinars and the quality of service they received.
This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.
Scopes: dashboard:read:admin
Rate Limit Label: Heavy
Prerequisites:

  • Business, Education or API Plan with Webinar add-on.

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
3 Query Parameters

Responses

HTTP Status Code: 200
Webinar participants returned.
Only available for paid accounts that have enabled the Dashboard feature.

1 Example
Schema
object

Participant QOS list.

page_count
integer

The number of pages returned for the request made.

1 validation
page_size
integer

The number of items per page.

2 validations
total_records
integer

The number of all records available across pages.

1 validation
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 exceed the current page size. The expiration period for this token is 15 minutes.

participants
array[object]

Array of user objects.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
webinarId
$$.env
1 variable not set
oauth_access_token