GET /metrics/webinars/{webinarId}/participants/{participantId}/qos
Retrieve details on the quality of service that participants from live or past webinars recieved.
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_webinars:read:admin
Rate Limit Label: Heavy
Prerequisites:
- Business, Education or API Plan with Zoom Rooms set up.
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
webinarId |
String | Yes |
The webinar ID or the webinar UUID. If a webinar ID is provided in the request instead of a UUID, the response will be for the latest webinar instance. If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request. |
participantId |
String | Yes |
Participant ID. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
type |
String | No |
The webinar type. Valid values:
Default value: "live" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.