DataFlex / Zoom API / Get daily usage report
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sDate
Integer iNew_users
Integer iMeetings
Integer iParticipants
Integer iMeeting_minutes
Integer iYear
Integer iMonth
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateInt Of hoQueryParams "year" 68423085 To iSuccess
Get ComUpdateInt Of hoQueryParams "month" 68423085 To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.zoom.us/v2/report/daily" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComIntOf Of hoJResp "year" To iYear
Get ComIntOf Of hoJResp "month" To iMonth
Move 0 To i
Get ComSizeOfArray Of hoJResp "dates" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "dates[i].date" To sDate
Get ComIntOf Of hoJResp "dates[i].new_users" To iNew_users
Get ComIntOf Of hoJResp "dates[i].meetings" To iMeetings
Get ComIntOf Of hoJResp "dates[i].participants" To iParticipants
Get ComIntOf Of hoJResp "dates[i].meeting_minutes" To iMeeting_minutes
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
