Zoom Public API Documentation
List meetings
GET {{baseUrl}}/metrics/meetings?type=live&from=<string>&to=<string>&page_size=30&next_page_token=<string>&group_id=<string>&group_include_participant=<boolean>&include_fields=tracking_fields&query_date_type=start_time
Lists the total live or past meetings that occurred during a specified period of time. This overview shows 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. Specify a monthly date range for the dashboard data using the Scopes: Rate Limit Label: from and to query parameters. The month should fall within the last six months. Prerequisites: * Business or a higher plan. dashboard_meetings:read:admin,dashboard:read:adminRESOURCE-INTENSIVE
Body
PARAM
| Key | Datatype | Required | Description |
type
|
string | A value to get the response for the corresponding meeting type. `past` - Meetings 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 the API will only query responses for live meetings. | |
from
|
string | (Required) The start date in 'yyyy-MM-dd HH:mm:ss' or '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. | |
to
|
string | (Required) The end date 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format. | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
group_id
|
string | The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API. **Note:** The API response will only contain meetings where the host is a member of the queried group ID if the "group_include_participant" is false. | |
group_include_participant
|
string | Whether the response will contain meetings where the participant is a member of the queried group ID. | |
include_fields
|
string | Set the value of this field to `tracking_fields` if you want to include tracking fields of each meeting in the response. | |
query_date_type
|
string | The type of date to query. This field is only supported when `type` is `past`. * `start_time` - Query by call start time. * `end_time` - Query by call end time. This value defaults to `start_time`. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"from": "<date>",
"to": "<date>",
"next_page_token": "<string>",
"page_count": "<integer>",
"page_size": 30,
"total_records": "<integer>",
"meetings": [
{
"host": "<string>",
"audio_quality": "poor",
"custom_keys": [
{
"key": "<string>",
"value": "<string>"
},
{
"key": "<string>",
"value": "<string>"
}
],
"dept": "<string>",
"duration": "<string>",
"email": "<string>",
"end_time": "<dateTime>",
"has_3rd_party_audio": "<boolean>",
"has_archiving": "<boolean>",
"has_pstn": "<boolean>",
"has_recording": "<boolean>",
"has_screen_share": "<boolean>",
"has_sip": "<boolean>",
"has_video": "<boolean>",
"has_voip": "<boolean>",
"has_manual_captions": "<boolean>",
"has_automated_captions": "<boolean>",
"id": "<long>",
"in_room_participants": "<integer>",
"participants": "<integer>",
"screen_share_quality": "bad",
"session_key": "<string>",
"start_time": "<dateTime>",
"topic": "<string>",
"tracking_fields": [
{
"field": "<string>",
"value": "<string>"
},
{
"field": "<string>",
"value": "<string>"
}
],
"user_type": "<string>",
"uuid": "<string>",
"video_quality": "poor"
},
{
"host": "<string>",
"audio_quality": "poor",
"custom_keys": [
{
"key": "<string>",
"value": "<string>"
},
{
"key": "<string>",
"value": "<string>"
}
],
"dept": "<string>",
"duration": "<string>",
"email": "<string>",
"end_time": "<dateTime>",
"has_3rd_party_audio": "<boolean>",
"has_archiving": "<boolean>",
"has_pstn": "<boolean>",
"has_recording": "<boolean>",
"has_screen_share": "<boolean>",
"has_sip": "<boolean>",
"has_video": "<boolean>",
"has_voip": "<boolean>",
"has_manual_captions": "<boolean>",
"has_automated_captions": "<boolean>",
"id": "<long>",
"in_room_participants": "<integer>",
"participants": "<integer>",
"screen_share_quality": "fair",
"session_key": "<string>",
"start_time": "<dateTime>",
"topic": "<string>",
"tracking_fields": [
{
"field": "<string>",
"value": "<string>"
},
{
"field": "<string>",
"value": "<string>"
}
],
"user_type": "<string>",
"uuid": "<string>",
"video_quality": "good"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/metrics/meetings?type=live&from=<string>&to=<string>&page_size=30&next_page_token=<string>&group_id=<string>&group_include_participant=<boolean>&include_fields=tracking_fields&query_date_type=start_time?type=live&from=<string>&to=<string>&page_size=30&next_page_token=<string>&group_id=<string>&group_include_participant=<boolean>&include_fields=tracking_fields&query_date_type=start_time' -H 'Accept: application/json'
ENDPOINTS