DataFlex / Zoom API / Get active/inactive host reports
Back to Collection Items
Use ChilkatAx-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 sId
String sEmail
String sUser_name
Integer iV_type
String sDept
Integer iMeetings
Integer iParticipants
Integer iMeeting_minutes
String sLast_client_version
String sLast_login_time
String sCreate_time
String sFrom
String sV_to
Integer iPage_count
Integer iPage_number
Integer iPage_size
Integer iTotal_records
Integer iTotal_meetings
Integer iTotal_participants
Integer iTotal_meeting_minutes
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 ComUpdateString Of hoQueryParams "type" "active" To iSuccess
Get ComUpdateString Of hoQueryParams "from" "1989-05-07" To iSuccess
Get ComUpdateString Of hoQueryParams "to" "1989-05-07" To iSuccess
Get ComUpdateInt Of hoQueryParams "page_size" 30 To iSuccess
Get ComUpdateInt Of hoQueryParams "page_number" 1 To iSuccess
Get ComUpdateString Of hoQueryParams "next_page_token" "quis officia in reprehenderit" 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/users" 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)
// {
// "from": "2019-08-14",
// "to": "2019-09-14",
// "page_count": 1,
// "page_number": 1,
// "page_size": 30,
// "total_records": 3,
// "total_meetings": 2,
// "total_participants": 10,
// "total_meeting_minutes": 10,
// "users": [
// {
// "id": "BzBAAAAAAAfprg",
// "email": "example@example.com",
// "user_name": "cbcvbvcbvbc",
// "type": 1,
// "dept": "",
// "meetings": 1,
// "participants": 5,
// "meeting_minutes": 5,
// "last_client_version": "4.4.1242.0623(win)",
// "last_login_time": "2019-09-13T16:21:40Z",
// "create_time": "2019-09-13T16:20:30Z"
// },
// {
// "id": "0CAAAAA6jxcA",
// "email": "example@example.com",
// "user_name": "xgdzgdfg",
// "type": 1,
// "dept": "Business",
// "meetings": 0,
// "participants": 0,
// "meeting_minutes": 0,
// "last_client_version": "4.4.1242.0623(win)",
// "last_login_time": "2019-07-23T00:28:00Z",
// "create_time": "2019-07-23T00:27:34Z"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "from" To sFrom
Get ComStringOf Of hoJResp "to" To sV_to
Get ComIntOf Of hoJResp "page_count" To iPage_count
Get ComIntOf Of hoJResp "page_number" To iPage_number
Get ComIntOf Of hoJResp "page_size" To iPage_size
Get ComIntOf Of hoJResp "total_records" To iTotal_records
Get ComIntOf Of hoJResp "total_meetings" To iTotal_meetings
Get ComIntOf Of hoJResp "total_participants" To iTotal_participants
Get ComIntOf Of hoJResp "total_meeting_minutes" To iTotal_meeting_minutes
Move 0 To i
Get ComSizeOfArray Of hoJResp "users" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "users[i].id" To sId
Get ComStringOf Of hoJResp "users[i].email" To sEmail
Get ComStringOf Of hoJResp "users[i].user_name" To sUser_name
Get ComIntOf Of hoJResp "users[i].type" To iV_type
Get ComStringOf Of hoJResp "users[i].dept" To sDept
Get ComIntOf Of hoJResp "users[i].meetings" To iMeetings
Get ComIntOf Of hoJResp "users[i].participants" To iParticipants
Get ComIntOf Of hoJResp "users[i].meeting_minutes" To iMeeting_minutes
Get ComStringOf Of hoJResp "users[i].last_client_version" To sLast_client_version
Get ComStringOf Of hoJResp "users[i].last_login_time" To sLast_login_time
Get ComStringOf Of hoJResp "users[i].create_time" To sCreate_time
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "type=active"
-d "from=1989-05-07"
-d "to=1989-05-07"
-d "page_size=30"
-d "page_number=1"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/users
Postman Collection Item JSON
{
"name": "Get active/inactive host reports",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/report/users?type=active&from=1989-05-07&to=1989-05-07&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"users"
],
"query": [
{
"key": "type",
"value": "active",
"description": "Active or inactive hosts.<br>`active` - Active hosts. <br>`inactive` - Inactive hosts."
},
{
"key": "from",
"value": "1989-05-07",
"description": "(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once."
},
{
"key": "to",
"value": "1989-05-07",
"description": "(Required) End date."
},
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "page_number",
"value": "1",
"description": "The page number of the current page in the returned records."
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
}
]
},
"description": "A user is considered to be an active host during the month specified in the \"from\" and \"to\" range, if the user has hosted at least one meeting during this period. If the user didn't host any meetings during this period, the user is considered to be inactive.<br>The Active Hosts report displays a list of meetings, participants, and meeting minutes for a specific time range, up to one month. The month should fall within the last six months.<br>The Inactive Hosts report pulls a list of users who were not active during a specific period of time. \nUse this API to retrieve an active or inactive host report for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months. <br>You can specify the type of report and date range using the query parameters.<br>\n**Scopes:** `report:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:**<br>\n* Pro or higher plan."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nActive or inactive hosts report returned.<br>\nThis is only available for paid account: {accountId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/users?type=active&from=1989-05-07&to=1989-05-07&page_size=30&page_number=1&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"users"
],
"query": [
{
"key": "type",
"value": "active"
},
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "page_number",
"value": "1"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"2019-08-14\",\n \"to\": \"2019-09-14\",\n \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 30,\n \"total_records\": 3,\n \"total_meetings\": 2,\n \"total_participants\": 10,\n \"total_meeting_minutes\": 10,\n \"users\": [\n {\n \"id\": \"BzBAAAAAAAfprg\",\n \"email\": \"example@example.com\",\n \"user_name\": \"cbcvbvcbvbc\",\n \"type\": 1,\n \"dept\": \"\",\n \"meetings\": 1,\n \"participants\": 5,\n \"meeting_minutes\": 5,\n \"last_client_version\": \"4.4.1242.0623(win)\",\n \"last_login_time\": \"2019-09-13T16:21:40Z\",\n \"create_time\": \"2019-09-13T16:20:30Z\"\n },\n {\n \"id\": \"0CAAAAA6jxcA\",\n \"email\": \"example@example.com\",\n \"user_name\": \"xgdzgdfg\",\n \"type\": 1,\n \"dept\": \"Business\",\n \"meetings\": 0,\n \"participants\": 0,\n \"meeting_minutes\": 0,\n \"last_client_version\": \"4.4.1242.0623(win)\",\n \"last_login_time\": \"2019-07-23T00:28:00Z\",\n \"create_time\": \"2019-07-23T00:27:34Z\"\n }\n ]\n}"
}
]
}
