Zoom Public API Documentation

videosdk-sessions-{session Id}-users

Number of APIs: 4

GET {{baseUrl}}/videosdk/sessions/:sessionId/users?type=live&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82

Use this API to return a list of users from live or past sessions. You can specify a monthly date range for this data using the from and to query parameters. The month should fall within the last six months.

If you do not provide the type query parameter, the API defaults to the live value and the API will only return metrics for users in a live session, if a session is currently in progress.
To view metrics on past session users, provide the past value for the type query parameter.

Rate Limit Label: Heavy

Prerequisites: * A Video SDK account.

2. Get sharing/recording details

GET {{baseUrl}}/videosdk/sessions/:sessionId/users/sharing?type=live&page_size=30&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82

Retrieve the sharing and recording details of participants from live or past sessions.
Rate Limit Label: Heavy
Prerequisites:
* A Video SDK Account.

3. List session users QoS

GET {{baseUrl}}/videosdk/sessions/:sessionId/users/qos?type=live&page_size=10&next_page_token=Usse957pzxvmYwlmCZ50a6CNXFrhztxuj82

Use this API to return a list of session users from live or past sessions along with the QoS (quality of service) they received during the session. For example, connection quality for sending and receiving video, audio, and shared content. You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.

If you do not provide the type query parameter, the API defaults to the live value and the API will only return metrics for users in a live session, if a session is currently in progress.
To view metrics on past session users, provide the past value for the type query parameter.

Rate Limit Label: Heavy

Prerequisites: * A Video SDK Account

4. Get session user QoS

GET {{baseUrl}}/videosdk/sessions/:sessionId/users/:userId/qos?type=live

Use this API to retrieve the quality of service (QoS) for users from live or past sessions. The data returned indicates the connection quality for sending and 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.

Rate Limit Label: Heavy

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.