DataFlex / Zoom API / Get IM metrics
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 sUser_id
String sUser_name
String sEmail
Integer iTotal_send
Integer iTotal_receive
Integer iGroup_send
Integer iGroup_receive
Integer iCalls_send
Integer iCalls_receive
Integer iFiles_send
Integer iFiles_receive
Integer iImages_send
Integer iImages_receive
Integer iVoice_send
Integer iVoice_receive
Integer iVideos_send
Integer iVideos_receive
Integer iEmoji_send
Integer iEmoji_receive
String sFrom
String sV_to
Integer iPage_count
Integer iPage_size
Integer iTotal_records
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 "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 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/metrics/im" 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-04-09",
// "to": "2019-05-09",
// "page_count": 1,
// "page_size": 1,
// "total_records": 1,
// "users": [
// {
// "user_id": "sdfjk393lklrf",
// "user_name": "culpa ipsum",
// "email": "example@example.com",
// "total_send": 20,
// "total_receive": 30,
// "group_send": 5,
// "group_receive": 5,
// "calls_send": 1,
// "calls_receive": 5,
// "files_send": 3,
// "files_receive": 8,
// "images_send": 5,
// "images_receive": 2,
// "voice_send": 0,
// "voice_receive": 3,
// "videos_send": 1,
// "videos_receive": 2,
// "emoji_send": 4,
// "emoji_receive": 5
// }
// ]
// }
// 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_size" To iPage_size
Get ComIntOf Of hoJResp "total_records" To iTotal_records
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].user_id" To sUser_id
Get ComStringOf Of hoJResp "users[i].user_name" To sUser_name
Get ComStringOf Of hoJResp "users[i].email" To sEmail
Get ComIntOf Of hoJResp "users[i].total_send" To iTotal_send
Get ComIntOf Of hoJResp "users[i].total_receive" To iTotal_receive
Get ComIntOf Of hoJResp "users[i].group_send" To iGroup_send
Get ComIntOf Of hoJResp "users[i].group_receive" To iGroup_receive
Get ComIntOf Of hoJResp "users[i].calls_send" To iCalls_send
Get ComIntOf Of hoJResp "users[i].calls_receive" To iCalls_receive
Get ComIntOf Of hoJResp "users[i].files_send" To iFiles_send
Get ComIntOf Of hoJResp "users[i].files_receive" To iFiles_receive
Get ComIntOf Of hoJResp "users[i].images_send" To iImages_send
Get ComIntOf Of hoJResp "users[i].images_receive" To iImages_receive
Get ComIntOf Of hoJResp "users[i].voice_send" To iVoice_send
Get ComIntOf Of hoJResp "users[i].voice_receive" To iVoice_receive
Get ComIntOf Of hoJResp "users[i].videos_send" To iVideos_send
Get ComIntOf Of hoJResp "users[i].videos_receive" To iVideos_receive
Get ComIntOf Of hoJResp "users[i].emoji_send" To iEmoji_send
Get ComIntOf Of hoJResp "users[i].emoji_receive" To iEmoji_receive
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -G -d "from=1989-05-07"
-d "to=1989-05-07"
-d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/im
Postman Collection Item JSON
{
"name": "Get IM metrics",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/im?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"im"
],
"query": [
{
"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": "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": "Get [metrics](https://support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) on how users are utilizing the Zoom Chat client.\n\nYou can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.<p style=\"background-color:#e1f5fe; color:#000000; padding:8px\"><b>Deprecated:</b> We will completely deprecate this endpoint in a future release. You can continue using this endpoint to query data for messages sent <b>before</b> July 1, 2021.</br></br>To get metrics on chat messages sent <b>on and after</b> July 1, 2021, use the <a href=\"https://marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardchat\">Get chat metrics API</a>.</p>\n\n**Scopes:** `dashboard_im:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`\n\n**Prerequisites:**\n\n* Business or a higher plan."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nIM details returned.<br>\nOnly available for paid accounts that have enabled the dashboard feature.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/im?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"im"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"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-04-09\",\n \"to\": \"2019-05-09\",\n \"page_count\": 1,\n \"page_size\": 1,\n \"total_records\": 1,\n \"users\": [\n {\n \"user_id\": \"sdfjk393lklrf\",\n \"user_name\": \"culpa ipsum\",\n \"email\": \"example@example.com\",\n \"total_send\": 20,\n \"total_receive\": 30,\n \"group_send\": 5,\n \"group_receive\": 5,\n \"calls_send\": 1,\n \"calls_receive\": 5,\n \"files_send\": 3,\n \"files_receive\": 8,\n \"images_send\": 5,\n \"images_receive\": 2,\n \"voice_send\": 0,\n \"voice_receive\": 3,\n \"videos_send\": 1,\n \"videos_receive\": 2,\n \"emoji_send\": 4,\n \"emoji_receive\": 5\n }\n ]\n}"
}
]
}
