PureBasic / Zoom API / Get sign In / sign out activity report
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"from","1989-05-07")
CkJsonObject::ckUpdateString(queryParams,"to","1989-05-07")
CkJsonObject::ckUpdateInt(queryParams,"page_size",68423085)
CkJsonObject::ckUpdateString(queryParams,"next_page_token","quis officia in reprehenderit")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.zoom.us/v2/report/activities",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "from=1989-05-07"
-d "to=1989-05-07"
-d "page_size=68423085"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/activities
Postman Collection Item JSON
{
"name": "Get sign In / sign out activity report",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/report/activities?from=1989-05-07&to=1989-05-07&page_size=68423085&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"activities"
],
"query": [
{
"key": "from",
"value": "1989-05-07",
"description": "Start date for which you would like to view the activity logs report. Using the `from` and `to` parameters, specify a monthly date range for the report as the API only provides one month worth of data in one request. The specified date range should fall within the last six months."
},
{
"key": "to",
"value": "1989-05-07",
"description": "End date up to which you would like to view the activity logs report."
},
{
"key": "page_size",
"value": "68423085",
"description": "The number of records to be returned within a single API call"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "Next page token is used to paginate through large result sets"
}
]
},
"description": "Retrieve a list of sign in / sign out activity logs [report](https://support.zoom.us/hc/en-us/articles/201363213-Getting-Started-with-Reports) of users under a Zoom account.<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>\nSuccess",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/activities?from=1989-05-07&to=1989-05-07&page_size=68423085&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"activities"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "68423085"
},
{
"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 \\\"email\\\": \\\"sfkjsldfhjdsf@dskjflhdsf.com\\\",\\n \\\"time\\\": \\\"2019-09-15T20:56:09Z\\\",\\n \\\"type\\\": \\\"Sign in\\\",\\n \\\"ip_address\\\": \\\"38.99.100.6\\\",\\n \\\"client_type\\\": \\\"Browser\\\",\\n \\\"version\\\": \\\"-\\\"\\n },\\n {\\n \\\"email\\\": \\\"dfdsfdfdf@gidfdfdl.com\\\",\\n \\\"time\\\": \\\"2019-09-15T19:13:41Z\\\",\\n \\\"type\\\": \\\"Sign in\\\",\\n \\\"ip_address\\\": \\\"38.99.100.6\\\",\\n \\\"client_type\\\": \\\"Browser\\\",\\n \\\"version\\\": \\\"-\\\"\\n },\\n {\\n \\\"email\\\": \\\"fdfdfdf@gfdgfdgdsfg.com\\\",\\n \\\"time\\\": \\\"2019-09-15T18:50:15Z\\\",\\n \\\"type\\\": \\\"Sign out\\\",\\n \\\"ip_address\\\": \\\"38.99.100.6\\\",\\n \\\"client_type\\\": \\\"Browser\\\",\\n \\\"version\\\": \\\"-\\\"\\n }\""
}
]
}