Zoom Public API Documentation
Get issues of Zoom Rooms
GET {{baseUrl}}/metrics/issues/zoomrooms/:zoomroomId?from=<date>&to=<date>&page_size=30&next_page_token=<string>
Use this API to return information about the Zoom Rooms in an account with issues, such as disconnected hardware or bandwidth issues. You can specify a monthly date range for the Dashboard data using the Prerequisites:
* A Business or a higher plan.
* A Zoom Room must be enabled in the account. Scopes: Rate Limit Label: from and to query parameters. The month should fall within the last six months. dashboard_home:read:admin,dashboard:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
from
|
string | (Required) 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. | |
to
|
string | (Required) End date. | |
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. |
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>",
"issue_details": [
{
"issue": "<string>",
"time": "<dateTime>"
},
{
"issue": "<string>",
"time": "<dateTime>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/metrics/issues/zoomrooms/:zoomroomId?from=<date>&to=<date>&page_size=30&next_page_token=<string>?from=<date>&to=<date>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS