Chilkat Online Tools

Unicode C++ / Zoom API / Get chat metrics

Back to Collection Items

void ChilkatSample(void)
    {
    queryParams.UpdateString(L"from",L"1989-05-07");    queryParams.UpdateString(L"to",L"1989-05-07");    queryParams.UpdateInt(L"page_size",30);    queryParams.UpdateString(L"next_page_token",L"quis officia in reprehenderit");    http.put_AuthToken(L"<access_token>");    resp->GetBodySb(sbResponseBody);    jResp.LoadSb(sbResponseBody);    jResp.put_EmitCompact(false);    jResp.put_I(i);    user_id = jResp.stringOf(L"users[i].user_id");    user_name = jResp.stringOf(L"users[i].user_name");    email = jResp.stringOf(L"users[i].email");    total_sent = jResp.IntOf(L"users[i].total_sent");    p2p_sent = jResp.IntOf(L"users[i].p2p_sent");    group_sent = jResp.IntOf(L"users[i].group_sent");    files_sent = jResp.IntOf(L"users[i].files_sent");    text_sent = jResp.IntOf(L"users[i].text_sent");    images_sent = jResp.IntOf(L"users[i].images_sent");    code_sippet_sent = jResp.IntOf(L"users[i].code_sippet_sent");    giphys_sent = jResp.IntOf(L"users[i].giphys_sent");    audio_sent = jResp.IntOf(L"users[i].audio_sent");    video_sent = jResp.IntOf(L"users[i].video_sent");    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}"
    }
  ]
}