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/{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:read:admin
Rate Limit Label: Heavy
Prerequisites:

  • Business, Education or API Plan with Zoom Rooms set up.

Authorization

oauth2 - authorizationCode

Request Parameters

2 Path Parameters
1 Query Parameter

Responses

HTTP Status Code: 200
Webinar participant QOS returned.

1 Example
Schema
object

Participant QOS.

user_id
string

Participant ID.

1 validation
user_name
string

Participant display name.

device
string

The type of device using which the participant joined the meeting.

ip_address
string

Participant’s IP address.

location
string

Participant’s location.

join_time
string

The time at which participant joined the meeting.

1 validation
leave_time
string

The time at which participant left the meeting.

1 validation
pc_name
string

Participant’s PC name.

domain
string

Participant’s PC domain.

mac_addr
string

Participant’s MAC address.

harddisk_id
string

Participant’s hard disk ID.

version
string

Participant’s Zoom Client version.

user_qos
array[object]

Quality of service provided to the user.

Send a Test Request

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