Logo
Zoom Public API Documentation

Get cloud recording usage report

GET {{baseUrl}}/report/cloud_recording?from=<date>&to=<date>&group_id=<string>

Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day earlier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days.

Prerequisites

  • Pro or higher plan.

Scopes: report:read:admin

Rate Limit Label: Heavy

 

Body PARAM

Key Datatype Required Description 
from
string (Required) Start date in 'yyyy-mm-dd' format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.
to
string (Required) End date.
group_id
string The group ID. To get a group ID, use the [**List groups**](/api-reference/zoom-api/methods#operation/groups) API. **Note:** The API response will only contain users who are members of the queried group ID.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "from": "<date>", "to": "<date>", "cloud_recording_storage": [ { "date": "<date>", "free_usage": "<string>", "plan_usage": "<string>", "usage": "<string>" }, { "date": "<date>", "free_usage": "<string>", "plan_usage": "<string>", "usage": "<string>" } ] }



Curl
curl -X GET 'https://api.zoom.us/v2/report/cloud_recording?from=<date>&to=<date>&group_id=<string>?from=<date>&to=<date>&group_id=<string>' -H 'Accept: application/json'

ENDPOINTS