Chilkat Online Tools

Ruby / Zoom API / List client meeting satisfaction

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/client/satisfaction",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-08-05",
#   "to": "2019-09-05",
#   "total_records": 30,
#   "client_satisfaction": [
#     {
#       "date": "2019-08-05",
#       "satisfaction_percent": 100,
#       "good_count": 5,
#       "none_count": 0,
#       "not_good_count": 1
#     },
#     {
#       "date": "2019-08-06",
#       "satisfaction_percent": 100,
#       "good_count": 0,
#       "none_count": 0,
#       "not_good_count": 0
#     }
#   ]
# }

# 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("client_satisfaction")
while i < count_i
    jResp.put_I(i)
    date = jResp.stringOf("client_satisfaction[i].date")
    satisfaction_percent = jResp.IntOf("client_satisfaction[i].satisfaction_percent")
    good_count = jResp.IntOf("client_satisfaction[i].good_count")
    none_count = jResp.IntOf("client_satisfaction[i].none_count")
    not_good_count = jResp.IntOf("client_satisfaction[i].not_good_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/client/satisfaction

Postman Collection Item JSON

{
  "name": "List client meeting satisfaction",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/client/satisfaction?from=1989-05-07&to=1989-05-07",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "client",
        "satisfaction"
      ],
      "query": [
        {
          "key": "from",
          "value": "1989-05-07",
          "description": "The start date for the query in “yyyy-mm-dd” format. "
        },
        {
          "key": "to",
          "value": "1989-05-07",
          "description": "The end date for the query in “yyyy-mm-dd” format. "
        }
      ]
    },
    "description": "If the [End of Meeting Feedback Survey](https://support.zoom.us/hc/en-us/articles/115005855266) option is enabled, attendees will be prompted with a survey window where they can tap either the **Thumbs Up** or **Thumbs Down** button that indicates their Zoom meeting experience. With this API, you can get information on the attendees' meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months.\n\nTo get information on the survey results with negative experiences (indicated by **Thumbs Down**), use the [Get Zoom Meetings Client Feedback API](https://marketplace.zoom.us/docs/api-reference/zoom-api/dashboards/dashboardclientfeedbackdetail).<br>\n**Scopes:** `dashboard:read:admin`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nClient satisfaction data returned. ",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/client/satisfaction?from=1989-05-07&to=1989-05-07",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "client",
            "satisfaction"
          ],
          "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-05\",\n \"to\": \"2019-09-05\",\n \"total_records\": 30,\n \"client_satisfaction\": [\n  {\n   \"date\": \"2019-08-05\",\n   \"satisfaction_percent\": 100,\n   \"good_count\": 5,\n   \"none_count\": 0,\n   \"not_good_count\": 1\n  },\n  {\n   \"date\": \"2019-08-06\",\n   \"satisfaction_percent\": 100,\n   \"good_count\": 0,\n   \"none_count\": 0,\n   \"not_good_count\": 0\n  }\n ]\n}"
    }
  ]
}