Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
Phone Dashboard
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Deprecated API Endpoints
get

/metrics/meetings/{meetingId}/participants/{participantId}/qos

Use this API to retrieve the quality of service (QoS) for participants from live or past meetings. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received.

This API will not return data if there is no data being sent or received at the time of request.

Note: When the sender sends its data, a timestamp is attached to the sender’s data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum.

Scopes: dashboard_meetings:read:admin
Rate Limit Label: Heavy

Authorization

oauth2 - authorizationCode

Request Parameters

2 Path Parameters
1 Query Parameter

Responses

HTTP Status Code: 200
Meeting participant QOS returned.
Only available for paid account that have enabled the dashboard feature.

1 Example
Schema
object

Participant QOS.

user_id
string

Participant ID.

1 validation
user_name
string

Participant display name.

This returns an empty string value if the account calling the API is a BAA account.

device
string

The type of device the participant used to joined the meeting.

Note: This response returns an empty string (““) value for any users who are not a part of the host’s account (external users).

ip_address
string

Participant’s IP address.

This returns an empty string value if the account calling the API is a BAA account.

location
string

Participant’s location.

This returns an empty string value if the account calling the API is a BAA account.

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

The participant’s PC domain.

Note: This response returns an empty string (““) value for any users who are not a part of the host’s account (external users).

mac_addr
string

The participant’s MAC address.

Note: This response returns an empty string (““) value for any users who are not a part of the host’s account (external users).

harddisk_id
string

The participant’s hard disk ID.

Note: This response returns an empty string (““) value for any users who are not a part of the host’s account (external users).

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
meetingId
participantId
$$.env
1 variable not set
oauth_access_token