Chilkat Online Tools

C / Zoom API / Get chat metrics

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *user_id;
    const char *user_name;
    const char *email;
    int total_sent;
    int p2p_sent;
    int group_sent;
    int files_sent;
    int text_sent;
    int images_sent;
    int code_sippet_sent;
    int giphys_sent;
    int audio_sent;
    int video_sent;
    const char *from;
    const char *v_to;
    int page_size;
    const char *next_page_token;
    int i;
    int count_i;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttp_Create();

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateString(queryParams,"from","1989-05-07");
    CkJsonObject_UpdateString(queryParams,"to","1989-05-07");
    CkJsonObject_UpdateInt(queryParams,"page_size",30);
    CkJsonObject_UpdateString(queryParams,"next_page_token","quis officia in reprehenderit");

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttp_putAuthToken(http,"<access_token>");

    resp = CkHttp_QuickRequestParams(http,"GET","https://api.zoom.us/v2/metrics/chat",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    from = CkJsonObject_stringOf(jResp,"from");
    v_to = CkJsonObject_stringOf(jResp,"to");
    page_size = CkJsonObject_IntOf(jResp,"page_size");
    next_page_token = CkJsonObject_stringOf(jResp,"next_page_token");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"users");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        user_id = CkJsonObject_stringOf(jResp,"users[i].user_id");
        user_name = CkJsonObject_stringOf(jResp,"users[i].user_name");
        email = CkJsonObject_stringOf(jResp,"users[i].email");
        total_sent = CkJsonObject_IntOf(jResp,"users[i].total_sent");
        p2p_sent = CkJsonObject_IntOf(jResp,"users[i].p2p_sent");
        group_sent = CkJsonObject_IntOf(jResp,"users[i].group_sent");
        files_sent = CkJsonObject_IntOf(jResp,"users[i].files_sent");
        text_sent = CkJsonObject_IntOf(jResp,"users[i].text_sent");
        images_sent = CkJsonObject_IntOf(jResp,"users[i].images_sent");
        code_sippet_sent = CkJsonObject_IntOf(jResp,"users[i].code_sippet_sent");
        giphys_sent = CkJsonObject_IntOf(jResp,"users[i].giphys_sent");
        audio_sent = CkJsonObject_IntOf(jResp,"users[i].audio_sent");
        video_sent = CkJsonObject_IntOf(jResp,"users[i].video_sent");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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}"
    }
  ]
}