Chilkat Online Tools

Ruby / Zoom API / Get top 25 Zoom Rooms with issues

Back to Collection Items

require '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 CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/issues/zoomrooms",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "from": "2019-05-22",
#   "to": "1958-10-24",
#   "total_records": -12352697,
#   "zoom_rooms": [
#     {
#       "id": "culpa Ut",
#       "room_name": "nisi dolor amet eiusmod",
#       "issues_count": -15865999
#     },
#     {
#       "id": "ipsum exercitation minim dolor",
#       "room_name": "veniam pariatur laboris qui",
#       "issues_count": 11887943
#     }
#   ]
# }

# 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("zoom_rooms")
while i < count_i
    jResp.put_I(i)
    id = jResp.stringOf("zoom_rooms[i].id")
    room_name = jResp.stringOf("zoom_rooms[i].room_name")
    issues_count = jResp.IntOf("zoom_rooms[i].issues_count")
    i = i + 1
end

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

Postman Collection Item JSON

{
  "name": "Get top 25 Zoom Rooms with issues",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/issues/zoomrooms?from=1989-05-07&to=1989-05-07",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "issues",
        "zoomrooms"
      ],
      "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 information on top 25 Zoom Rooms with issues in a month. The month specified with the \"from\" and \"to\" range should fall within the last six months.<br>\n**Scope:** `dashboard_home:read:admin`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:**<br>\n* Business or a higher plan.\n* Zoom Room must be enabled in the account."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nZoom Room with issue details returned",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/issues/zoomrooms?from=1989-05-07&to=1989-05-07",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "issues",
            "zoomrooms"
          ],
          "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-05-22\",\n \"to\": \"1958-10-24\",\n \"total_records\": -12352697,\n \"zoom_rooms\": [\n  {\n   \"id\": \"culpa Ut\",\n   \"room_name\": \"nisi dolor amet eiusmod\",\n   \"issues_count\": -15865999\n  },\n  {\n   \"id\": \"ipsum exercitation minim dolor\",\n   \"room_name\": \"veniam pariatur laboris qui\",\n   \"issues_count\": 11887943\n  }\n ]\n}"
    }
  ]
}