Chilkat Online Tools

delphiAx / Zoom API / Get IM metrics

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
user_id: WideString;
user_name: WideString;
email: WideString;
total_send: Integer;
total_receive: Integer;
group_send: Integer;
group_receive: Integer;
calls_send: Integer;
calls_receive: Integer;
files_send: Integer;
files_receive: Integer;
images_send: Integer;
images_receive: Integer;
voice_send: Integer;
voice_receive: Integer;
videos_send: Integer;
videos_receive: Integer;
emoji_send: Integer;
emoji_receive: Integer;
from: WideString;
v_to: WideString;
page_count: Integer;
page_size: Integer;
total_records: Integer;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('from','1989-05-07');
queryParams.UpdateString('to','1989-05-07');
queryParams.UpdateInt('page_size',30);
queryParams.UpdateString('next_page_token','quis officia in reprehenderit');

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';

resp := http.QuickRequestParams('GET','https://api.zoom.us/v2/metrics/im',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

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

from := jResp.StringOf('from');
v_to := jResp.StringOf('to');
page_count := jResp.IntOf('page_count');
page_size := jResp.IntOf('page_size');
total_records := jResp.IntOf('total_records');
i := 0;
count_i := jResp.SizeOfArray('users');
while i < count_i do
  begin
    jResp.I := i;
    user_id := jResp.StringOf('users[i].user_id');
    user_name := jResp.StringOf('users[i].user_name');
    email := jResp.StringOf('users[i].email');
    total_send := jResp.IntOf('users[i].total_send');
    total_receive := jResp.IntOf('users[i].total_receive');
    group_send := jResp.IntOf('users[i].group_send');
    group_receive := jResp.IntOf('users[i].group_receive');
    calls_send := jResp.IntOf('users[i].calls_send');
    calls_receive := jResp.IntOf('users[i].calls_receive');
    files_send := jResp.IntOf('users[i].files_send');
    files_receive := jResp.IntOf('users[i].files_receive');
    images_send := jResp.IntOf('users[i].images_send');
    images_receive := jResp.IntOf('users[i].images_receive');
    voice_send := jResp.IntOf('users[i].voice_send');
    voice_receive := jResp.IntOf('users[i].voice_receive');
    videos_send := jResp.IntOf('users[i].videos_send');
    videos_receive := jResp.IntOf('users[i].videos_receive');
    emoji_send := jResp.IntOf('users[i].emoji_send');
    emoji_receive := jResp.IntOf('users[i].emoji_receive');
    i := i + 1;
  end;

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