VB6 / Zoom API / Get active/inactive host reports
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("type","active")
success = queryParams.UpdateString("from","1989-05-07")
success = queryParams.UpdateString("to","1989-05-07")
success = queryParams.UpdateInt("page_size",30)
success = queryParams.UpdateInt("page_number",1)
success = queryParams.UpdateString("next_page_token","quis officia in reprehenderit")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/report/users",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim id As String
Dim email As String
Dim user_name As String
Dim v_type As Long
Dim dept As String
Dim meetings As Long
Dim participants As Long
Dim meeting_minutes As Long
Dim last_client_version As String
Dim last_login_time As String
Dim create_time As String
Dim from As String
from = jResp.StringOf("from")
Dim v_to As String
v_to = jResp.StringOf("to")
Dim page_count As Long
page_count = jResp.IntOf("page_count")
Dim page_number As Long
page_number = jResp.IntOf("page_number")
Dim page_size As Long
page_size = jResp.IntOf("page_size")
Dim total_records As Long
total_records = jResp.IntOf("total_records")
Dim total_meetings As Long
total_meetings = jResp.IntOf("total_meetings")
Dim total_participants As Long
total_participants = jResp.IntOf("total_participants")
Dim total_meeting_minutes As Long
total_meeting_minutes = jResp.IntOf("total_meeting_minutes")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("users")
Do While i < count_i
jResp.I = i
id = jResp.StringOf("users[i].id")
email = jResp.StringOf("users[i].email")
user_name = jResp.StringOf("users[i].user_name")
v_type = jResp.IntOf("users[i].type")
dept = jResp.StringOf("users[i].dept")
meetings = jResp.IntOf("users[i].meetings")
participants = jResp.IntOf("users[i].participants")
meeting_minutes = jResp.IntOf("users[i].meeting_minutes")
last_client_version = jResp.StringOf("users[i].last_client_version")
last_login_time = jResp.StringOf("users[i].last_login_time")
create_time = jResp.StringOf("users[i].create_time")
i = i + 1
Loop
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}"
}
]
}
