SQL Server / Zoom API / Get daily usage report
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'year', 68423085
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'month', 68423085
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.zoom.us/v2/report/daily', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @date nvarchar(4000)
DECLARE @new_users int
DECLARE @meetings int
DECLARE @participants int
DECLARE @meeting_minutes int
DECLARE @year int
EXEC sp_OAMethod @jResp, 'IntOf', @year OUT, 'year'
DECLARE @month int
EXEC sp_OAMethod @jResp, 'IntOf', @month OUT, 'month'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'dates'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @date OUT, 'dates[i].date'
EXEC sp_OAMethod @jResp, 'IntOf', @new_users OUT, 'dates[i].new_users'
EXEC sp_OAMethod @jResp, 'IntOf', @meetings OUT, 'dates[i].meetings'
EXEC sp_OAMethod @jResp, 'IntOf', @participants OUT, 'dates[i].participants'
EXEC sp_OAMethod @jResp, 'IntOf', @meeting_minutes OUT, 'dates[i].meeting_minutes'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
