GET /metrics/meetings
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.
Servers
- https://api.zoom.us/v2
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
to |
String | Yes |
End date. |
page_size |
Integer | No |
The number of records returned within a single API call. Default value: 30 |
type |
String | No |
Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following: If you do not provide this field, the default value will be Valid values:
Default value: "live" |
next_page_token |
String | No |
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 |
String | No |
Set the value of this field to "tracking_fields" if you would like to include tracking fields of each meeting in the response. Valid values:
|
from |
String | Yes |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.