List meeting participants QoS

GET

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

Get a list of meeting participants from live or past meetings along with the quality of service they recieve during the meeting such as connection quality for sending/receiving video, audio, and shared content.
If you do not provide the type query parameter, the default value will be set to live and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for type.

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.

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

Business or a higher plan.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/metrics/meetings//participants/qos'

响应示例

200 - response

{
    "next_page_token": "string",
    "page_count": "integer [int64]",
    "page_size": "integer",
    "participants": [
        {
            "device": "string",
            "domain": "string",
            "harddisk_id": "string",
            "ip_address": "string",
            "join_time": "string [date-time]",
            "leave_time": "string [date-time]",
            "location": "string",
            "mac_addr": "string",
            "pc_name": "string",
            "user_id": "string [uuid]",
            "user_name": "string",
            "user_qos": [
                {
                    "as_input": {
                        "avg_loss": "string",
                        "bitrate": "string",
                        "frame_rate": "string",
                        "jitter": "string",
                        "latency": "string",
                        "max_loss": "string",
                        "resolution": "string"
                    },
                    "as_output": {
                        "avg_loss": "string",
                        "bitrate": "string",
                        "frame_rate": "string",
                        "jitter": "string",
                        "latency": "string",
                        "max_loss": "string",
                        "resolution": "string"
                    },
                    "audio_input": {
                        "avg_loss": "string",
                        "bitrate": "string",
                        "jitter": "string",
                        "latency": "string",
                        "max_loss": "string"
                    },
                    "audio_output": {
                        "avg_loss": "string",
                        "bitrate": "string",
                        "jitter": "string",
                        "latency": "string",
                        "max_loss": "string"
                    },
                    "cpu_usage": {
                        "system_max_cpu_usage": "string",
                        "zoom_avg_cpu_usage": "string",
                        "zoom_max_cpu_usage": "string",
                        "zoom_min_cpu_usage": "string"
                    },
                    "date_time": "string [date-time]",
                    "video_input": {
                        "avg_loss": "string",
                        "bitrate": "string",
                        "frame_rate": "string",
                        "jitter": "string",
                        "latency": "string",
                        "max_loss": "string",
                        "resolution": "string"
                    },
                    "video_output": {
                        "avg_loss": "string",
                        "bitrate": "string",
                        "frame_rate": "string",
                        "jitter": "string",
                        "latency": "string",
                        "max_loss": "string",
                        "resolution": "string"
                    }
                }
            ],
            "version": "string"
        }
    ],
    "total_records": "integer [int64]"
}

请求参数

Path 参数

meetingId

string

必需

The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance.

If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

Query 参数

type

enum<string>

可选

The meeting types:
past - Past meetings.
live - Live Meetings.

枚举值:

pastpastOnelive

默认值:

live

page_size

integer

可选

The number of items returned per page.

<= 10

默认值:

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

返回响应

🟢200**HTTP Status Code:** `200` Meeting participants returned. Only available for paid accounts that have enabled the dashboard feature.

application/json

Body

Participant QOS list.

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.

page_count

integer <int64>

可选

The number of pages returned for the request made.

page_size

integer

可选

The number of items per page.

<= 10

默认值:

total_records

integer <int64>

可选

The number of all records available across pages.

participants

array[object (Participant QOS) {13}]

可选

Array of user objects.

device

string

可选

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

domain

string

可选

Participant's PC domain.

harddisk_id

string

可选

Participant's hard disk ID.

ip_address

string

可选

Participant's IP address.

join_time

string <date-time>

可选

The time at which participant joined the meeting.

leave_time

string <date-time>

可选

The time at which participant left the meeting.

location

string

可选

Participant's location.

mac_addr

string

可选

Participant's MAC address.

pc_name

string

可选

Participant's PC name.

user_id

string <uuid>

可选

Participant ID.

user_name

string

可选

Participant display name.

user_qos

array [object {14}]

可选

Quality of service provided to the user.

version

string

可选

Participant's Zoom Client version.

🔵300**Error Code:** `300` Can not access webinar info, {meetingId}. The next page token is either invalid or expired.

🟠404**HTTP Status Code:** `404` **Error Code:** `3001` This meeting's detail info is not available. The Meeting ID is not valid or the meeting has not ended yet.

修改于 2024-04-24 09:06:48

List meeting participants

Get post meeting feedback