Zoom Public API Documentation
Get CRC port usage
GET {{baseUrl}}/metrics/crc?from=<date>&to=<date>
A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. Use this API to get the hour by hour CRC Port usage for a specified period of time. <aside class='notice'>We will provide the report for a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is set to "2017-10-10", we will adjust "from" to "2017-09-10".</aside> Prerequisites: Scopes: Rate Limit Label:
dashboard_crc: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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"from": "<date>",
"to": "<date>",
"crc_ports_usage": [
{
"crc_ports_hour_usage": [
{
"hour": "<string>",
"max_usage": "<integer>",
"total_usage": "<integer>"
},
{
"hour": "<string>",
"max_usage": "<integer>",
"total_usage": "<integer>"
}
],
"date_time": "<date>"
},
{
"crc_ports_hour_usage": [
{
"hour": "<string>",
"max_usage": "<integer>",
"total_usage": "<integer>"
},
{
"hour": "<string>",
"max_usage": "<integer>",
"total_usage": "<integer>"
}
],
"date_time": "<date>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/metrics/crc?from=<date>&to=<date>?from=<date>&to=<date>' -H 'Accept: application/json'
ENDPOINTS