Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Account
Audio Library
Auto Receptionists
Blocked List
Call Handling
Call Logs
Call Queues
Carrier Reseller
Common Area Phones
Dashboard
Devices
Directory Backup Routing Rules
Emergency Service Locations
External Contacts
IVR
Monitoring Groups
Phone Numbers
Provider Exchange
Recordings
Reports
Setting Templates
Settings
Shared Access
Shared Line Group
Site
SMS
Users
Voicemails
Zoom Rooms
Cloud Recording
Sessions
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
Video SDK Events
Zoom Room Events
Deprecated API Endpoints
get

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

Use this API to return the quality of service (QoS) report 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.

When the sender sends 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.

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

Note:

This API may return empty values for participants’ user_name, ip_address, location, and email responses when the account calling this API:

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

Information about the participant and their quality of service (QoS).

user_id
string

The participant’s ID. This value is assigned to a participant upon joining a meeting and is only valid for the meeting’s duration.

user_name
string

The participant’s display name.

device
string

The type of device the participant used to join the meeting:

  • Phone — The participant joined via PSTN.
  • H.323/SIP — The participant joined via an H.323 or SIP device.
  • Windows — The participant joined via VoIP using a Windows device.
  • Mac — The participant joined via VoIP using a Mac device.
  • iOS — The participant joined via VoIP using an iOS device.
  • Android — The participant joined via VoIP using an Android device.

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

1 validation
ip_address
string

The participant’s IP address.

location
string

The participant’s location.

join_time
string

The time at which the participant joined the meeting.

1 validation
leave_time
string

The time at which the participant left the meeting.

1 validation
pc_name
string

The 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

The participant’s Zoom client version.

user_qos
array[object]

The participant’s quality of service information.

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