List meetings

GET

/metrics/meetings

Dashboards

List total live or past meetings that occurred during a specified period of time. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.
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: Resource-intensive

Prerequisites:

Business or a higher plan.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/metrics/meetings?from&to'

响应示例

200 - response

{
  "from": "string [date]",
  "meetings": [
    {
      "duration": "string",
      "email": "string",
      "end_time": "string [date-time]",
      "has_3rd_party_audio": "boolean",
      "has_pstn": "boolean",
      "has_recording": "boolean",
      "has_screen_share": "boolean",
      "has_sip": "boolean",
      "has_video": "boolean",
      "has_voip": "boolean",
      "host": "string",
      "id": "integer",
      "participants": "integer",
      "start_time": "string [date-time]",
      "topic": "string",
      "user_type": "string",
      "uuid": "string [uuid]"
    }
  ],
  "next_page_token": "string",
  "page_count": "integer",
  "page_size": "integer",
  "to": "string [date]",
  "total_records": "integer"
}

请求参数

Query 参数

type

enum<string>

可选

Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:

past - Meeting that already occurred in the specified date range.
pastOne - Past meetings that were attended by only one user.
live - Live meetings.

If you do not provide this field, the default value will be live and thus, the API will only query responses for live meetings.

枚举值:

pastpastOnelive

默认值:

live

from

string <date>

必需

Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

string <date>

End date.

必需

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

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.

include_fields

enum<string>

可选

Set the value of this field to "tracking_fields" if you would like to include tracking fields of each meeting in the response.

枚举值:

tracking_fields

返回响应

🟢200**HTTP Status Code:** `200`<br> Meetings returned.<br> Only available for paid accounts that have dashboard feature enabled.

application/json

Body

Pagination object.

from

string <date>

可选

Start date for this report in 'yyyy-mm-dd' format.

string <date>

可选

End date for this report in 'yyyy-mm-dd' format.

next_page_token

string

可选

page_count

integer

可选

The number of pages returned for the request made.

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

total_records

integer

可选

The number of all records available across pages.

meetings

array[object (Metrics) {21}]

可选

Array of meeting objects.

custom_keys

array [object {2}]

可选

Custom keys and values assigned to the meeting.

<= 10 items

dept

string

可选

Department of the host.

duration

string

可选

Meeting duration. Formatted as hh:mm:ss, for example: 16:08 for 16 minutes and 8 seconds.

string

可选

Email address of the host.

end_time

string <date-time>

可选

Meeting end time.

has_3rd_party_audio

boolean

可选

Indicates whether or not third party audio was used in the meeting.

has_pstn

boolean

可选

Indicates whether or not the PSTN was used in the meeting.

has_recording

boolean

可选

Indicates whether or not the recording feature was used in the meeting.

has_screen_share

boolean

可选

Indicates whether or not screenshare feature was used in the meeting.

has_sip

boolean

可选

Indicates whether or not someone joined the meeting using SIP.

has_video

boolean

可选

Indicates whether or not video was used in the meeting.

has_voip

boolean

可选

Indicates whether or not VoIP was used in the meeting.

host

string

可选

Host display name.

integer <int64>

可选

Meeting ID: Unique identifier of the meeting in "long" format(represented as int64 data type in JSON), also known as the meeting number.

in_room_participants

integer

可选

The number of Zoom Room participants in the meeting.

participants

integer

可选

Meeting participant count.

start_time

string <date-time>

可选

Meeting start time.

topic

string

可选

Meeting topic.

tracking_fields

array [object {2}]

可选

Tracking fields and values assigned to the meeting.

user_type

string

可选

License type of the user.

uuid

string <uuid>

可选

Meeting UUID. Please double encode your UUID when using it for API calls if the UUID begins with a '/'or contains '//' in it.

🔵300**Error Code:** `300`<br> The next page token is invalid or expired.

Get issues of Zoom Rooms

Get meeting details