PowerBuilder / Zoom API / Get daily usage report
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Date
integer li_New_users
integer li_Meetings
integer li_Participants
integer li_Meeting_minutes
integer li_Year
integer li_Month
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateInt("year",68423085)
loo_QueryParams.UpdateInt("month",68423085)
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.zoom.us/v2/report/daily",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
li_Year = loo_JResp.IntOf("year")
li_Month = loo_JResp.IntOf("month")
i = 0
li_Count_i = loo_JResp.SizeOfArray("dates")
do while i < li_Count_i
loo_JResp.I = i
ls_Date = loo_JResp.StringOf("dates[i].date")
li_New_users = loo_JResp.IntOf("dates[i].new_users")
li_Meetings = loo_JResp.IntOf("dates[i].meetings")
li_Participants = loo_JResp.IntOf("dates[i].participants")
li_Meeting_minutes = loo_JResp.IntOf("dates[i].meeting_minutes")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_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": ""
}
]
}
