Chilkat Online Tools

Perl / Zoom API / Get top 25 issues of Zoom Rooms

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("from","1989-05-07");
$queryParams->UpdateString("to","1989-05-07");

# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");

# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://api.zoom.us/v2/metrics/zoomrooms/issues",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "from": "2019-08-15",
#   "to": "2019-09-15",
#   "total_records": 2,
#   "room_issues": [
#     {
#       "issue_name": "Controller disconnected",
#       "zoom_rooms_count": 1
#     },
#     {
#       "issue_name": "Controller is not charging",
#       "zoom_rooms_count": 1
#     }
#   ]
# }

# 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");
$total_records = $jResp->IntOf("total_records");
$i = 0;
$count_i = $jResp->SizeOfArray("room_issues");
while ($i < $count_i) {
    $jResp->put_I($i);
    $issue_name = $jResp->stringOf("room_issues[i].issue_name");
    $zoom_rooms_count = $jResp->IntOf("room_issues[i].zoom_rooms_count");
    $i = $i + 1;
}

Curl Command

curl -G -d "from=1989-05-07"
	-d "to=1989-05-07"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/zoomrooms/issues

Postman Collection Item JSON

{
  "name": "Get top 25 issues of Zoom Rooms",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/zoomrooms/issues?from=1989-05-07&to=1989-05-07",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "zoomrooms",
        "issues"
      ],
      "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."
        }
      ]
    },
    "description": "Get top 25 issues of Zoom Rooms.<br>\n**Scopes:** `dashboard_zr:read:admin`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n **Prerequisites:**<br>\n* Business, Education or API Plan with Zoom Rooms set up.\n\n"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nZoom Room Issue details returned",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/zoomrooms/issues?from=1989-05-07&to=1989-05-07",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "zoomrooms",
            "issues"
          ],
          "query": [
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"from\": \"2019-08-15\",\n \"to\": \"2019-09-15\",\n \"total_records\": 2,\n \"room_issues\": [\n  {\n   \"issue_name\": \"Controller disconnected\",\n   \"zoom_rooms_count\": 1\n  },\n  {\n   \"issue_name\": \"Controller is not charging\",\n   \"zoom_rooms_count\": 1\n  }\n ]\n}"
    }
  ]
}