C / Zoom API / Get daily usage report
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *date;
int new_users;
int meetings;
int participants;
int meeting_minutes;
int year;
int month;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateInt(queryParams,"year",68423085);
CkJsonObject_UpdateInt(queryParams,"month",68423085);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
resp = CkHttp_QuickRequestParams(http,"GET","https://api.zoom.us/v2/report/daily",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "year": 2019,
// "month": 6,
// "dates": [
// {
// "date": "2019-06-01",
// "new_users": 3,
// "meetings": 10,
// "participants": 20,
// "meeting_minutes": 100
// },
// {
// "date": "2019-06-02",
// "new_users": 0,
// "meetings": 20,
// "participants": 80,
// "meeting_minutes": 200
// },
// {
// "date": "2019-06-03",
// "new_users": 10,
// "meetings": 35,
// "participants": 100,
// "meeting_minutes": 380
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
year = CkJsonObject_IntOf(jResp,"year");
month = CkJsonObject_IntOf(jResp,"month");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"dates");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
date = CkJsonObject_stringOf(jResp,"dates[i].date");
new_users = CkJsonObject_IntOf(jResp,"dates[i].new_users");
meetings = CkJsonObject_IntOf(jResp,"dates[i].meetings");
participants = CkJsonObject_IntOf(jResp,"dates[i].participants");
meeting_minutes = CkJsonObject_IntOf(jResp,"dates[i].meeting_minutes");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -G -d "year=68423085"
-d "month=68423085"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/daily
Postman Collection Item JSON
{
"name": "Get daily usage report",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/report/daily?year=68423085&month=68423085",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"daily"
],
"query": [
{
"key": "year",
"value": "68423085",
"description": "Year for this report"
},
{
"key": "month",
"value": "68423085",
"description": "Month for this report"
}
]
},
"description": "Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes.<br>\n**Prerequisites**<br>\n* Pro or higher plan.<br>\n**Scopes:** `report:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nDaily report retrieved.<br>\nThis is only available for paid accounts:{accountId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/daily?year=68423085&month=68423085",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"daily"
],
"query": [
{
"key": "year",
"value": "68423085"
},
{
"key": "month",
"value": "68423085"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"year\": 2019,\n \"month\": 6,\n \"dates\": [\n {\n \"date\": \"2019-06-01\",\n \"new_users\": 3,\n \"meetings\": 10,\n \"participants\": 20,\n \"meeting_minutes\": 100\n },\n {\n \"date\": \"2019-06-02\",\n \"new_users\": 0,\n \"meetings\": 20,\n \"participants\": 80,\n \"meeting_minutes\": 200\n },\n {\n \"date\": \"2019-06-03\",\n \"new_users\": 10,\n \"meetings\": 35,\n \"participants\": 100,\n \"meeting_minutes\": 380\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\n**Error Code:** `300`<br> \nDaily report can only be provided for a month that falls within the recent 6 months.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/daily?year=68423085&month=68423085",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"daily"
],
"query": [
{
"key": "year",
"value": "68423085"
},
{
"key": "month",
"value": "68423085"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
