Chilkat Online Tools

autoit / Zoom API / Get daily usage report

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateInt("year",68423085)
$oQueryParams.UpdateInt("month",68423085)

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

Local $oResp = $oHttp.QuickRequestParams("GET","https://api.zoom.us/v2/report/daily",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sDate
Local $iNew_users
Local $iMeetings
Local $iParticipants
Local $iMeeting_minutes

Local $iYear = $oJResp.IntOf("year")
Local $iMonth = $oJResp.IntOf("month")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("dates")
While $i < $iCount_i
    $oJResp.I = $i
    $sDate = $oJResp.StringOf("dates[i].date")
    $iNew_users = $oJResp.IntOf("dates[i].new_users")
    $iMeetings = $oJResp.IntOf("dates[i].meetings")
    $iParticipants = $oJResp.IntOf("dates[i].participants")
    $iMeeting_minutes = $oJResp.IntOf("dates[i].meeting_minutes")
    $i = $i + 1
Wend

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": ""
    }
  ]
}