Swift3 / Zoom API / Get chat metrics
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
let queryParams = CkoJsonObject()!
queryParams.update("from", value: "1989-05-07")
queryParams.update("to", value: "1989-05-07")
queryParams.updateInt("page_size", value: 30)
queryParams.update("next_page_token", value: "quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
http.authToken = "<access_token>"
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.zoom.us/v2/metrics/chat", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "from": "2019-04-09",
// "to": "2019-05-09",
// "page_size": 1,
// "next_page_token": "",
// "users": [
// {
// "user_id": "sdfjk393lklrf",
// "user_name": "culpa ipsum",
// "email": "example@example.com",
// "total_sent": 20,
// "p2p_sent": 30,
// "group_sent": 5,
// "files_sent": 3,
// "text_sent": 8,
// "images_sent": 5,
// "code_sippet_sent": 2,
// "giphys_sent": 2,
// "audio_sent": 4,
// "video_sent": 5
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var user_id: String?
var user_name: String?
var email: String?
var total_sent: Int
var p2p_sent: Int
var group_sent: Int
var files_sent: Int
var text_sent: Int
var images_sent: Int
var code_sippet_sent: Int
var giphys_sent: Int
var audio_sent: Int
var video_sent: Int
var from: String? = jResp.string(of: "from")
var v_to: String? = jResp.string(of: "to")
var page_size: Int = jResp.int(of: "page_size").intValue
var next_page_token: String? = jResp.string(of: "next_page_token")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "users").intValue
while i < count_i {
jResp.i = i
user_id = jResp.string(of: "users[i].user_id")
user_name = jResp.string(of: "users[i].user_name")
email = jResp.string(of: "users[i].email")
total_sent = jResp.int(of: "users[i].total_sent").intValue
p2p_sent = jResp.int(of: "users[i].p2p_sent").intValue
group_sent = jResp.int(of: "users[i].group_sent").intValue
files_sent = jResp.int(of: "users[i].files_sent").intValue
text_sent = jResp.int(of: "users[i].text_sent").intValue
images_sent = jResp.int(of: "users[i].images_sent").intValue
code_sippet_sent = jResp.int(of: "users[i].code_sippet_sent").intValue
giphys_sent = jResp.int(of: "users[i].giphys_sent").intValue
audio_sent = jResp.int(of: "users[i].audio_sent").intValue
video_sent = jResp.int(of: "users[i].video_sent").intValue
i = i + 1
}
}
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/chat
Postman Collection Item JSON
{
"name": "Get chat metrics",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/chat?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"chat"
],
"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) for how users are utilizing Zoom Chat to send messages.\n\nUse the `from` and `to` query parameters to specify a monthly date range for the dashboard data. The monthly date range must be within the last six months.\n\n> **Note:** To query chat metrics from July 1, 2021 and later, use this endpoint instead of the [Get IM metrics API](https://marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardim).\n\n**Scope:** `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>\nChat 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/chat?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"chat"
],
"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_size\": 1,\n \"next_page_token\": \"\",\n \"users\": [\n {\n \"user_id\": \"sdfjk393lklrf\",\n \"user_name\": \"culpa ipsum\",\n \"email\": \"example@example.com\",\n \"total_sent\": 20,\n \"p2p_sent\": 30,\n \"group_sent\": 5,\n \"files_sent\": 3,\n \"text_sent\": 8,\n \"images_sent\": 5,\n \"code_sippet_sent\": 2,\n \"giphys_sent\": 2,\n \"audio_sent\": 4,\n \"video_sent\": 5\n }\n ]\n}"
}
]
}
