PureBasic / Zoom API / List Zoom meetings client feedback
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"from","1989-05-07")
CkJsonObject::ckUpdateString(queryParams,"to","1989-05-07")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.zoom.us/v2/metrics/client/feedback",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "from": "2013-03-16",
; "to": "2013-04-16",
; "total_records": 2,
; "client_feedbacks": [
; {
; "feedback_id": "53532100000",
; "feedback_name": "Poor audio quality.",
; "participants_count": 1
; },
; {
; "feedback_id": "53532100000",
; "feedback_name": "They could not hear us.",
; "participants_count": 2
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
feedback_id.s
feedback_name.s
participants_count.i
from.s = CkJsonObject::ckStringOf(jResp,"from")
v_to.s = CkJsonObject::ckStringOf(jResp,"to")
total_records.i = CkJsonObject::ckIntOf(jResp,"total_records")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"client_feedbacks")
While i < count_i
CkJsonObject::setCkI(jResp, i)
feedback_id = CkJsonObject::ckStringOf(jResp,"client_feedbacks[i].feedback_id")
feedback_name = CkJsonObject::ckStringOf(jResp,"client_feedbacks[i].feedback_name")
participants_count = CkJsonObject::ckIntOf(jResp,"client_feedbacks[i].participants_count")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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/feedback
Postman Collection Item JSON
{
"name": "List Zoom meetings client feedback",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/client/feedback?from=1989-05-07&to=1989-05-07",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"client",
"feedback"
],
"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": "Use this API to return [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf) survey results. You 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. \n\n**Scopes:** `dashboard_home:read:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy` \n\n**Prerequisites:** \n* A Business or higher account. \n* The \"[**Feedback to Zoom**](https://support.zoom.us/hc/en-us/articles/115005838023)\" option enabled."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nClient Feedback details returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/client/feedback?from=1989-05-07&to=1989-05-07",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"client",
"feedback"
],
"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\": \"2013-03-16\",\n \"to\": \"2013-04-16\",\n \"total_records\": 2,\n \"client_feedbacks\": [\n {\n \"feedback_id\": \"53532100000\",\n \"feedback_name\": \"Poor audio quality.\",\n \"participants_count\": 1\n },\n {\n \"feedback_id\": \"53532100000\",\n \"feedback_name\": \"They could not hear us.\",\n \"participants_count\": 2\n }\n ]\n}"
}
]
}
