Chilkat Online Tools

Objective-C / Zoom API / List Zoom meetings client feedback

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"from" value: @"1989-05-07"];
[queryParams UpdateString: @"to" value: @"1989-05-07"];

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

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://api.zoom.us/v2/metrics/client/feedback" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

NSString *feedback_id = 0;
NSString *feedback_name = 0;
int participants_count;

NSString *from = [jResp StringOf: @"from"];
NSString *v_to = [jResp StringOf: @"to"];
int total_records = [[jResp IntOf: @"total_records"] intValue];
int i = 0;
int count_i = [[jResp SizeOfArray: @"client_feedbacks"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    feedback_id = [jResp StringOf: @"client_feedbacks[i].feedback_id"];
    feedback_name = [jResp StringOf: @"client_feedbacks[i].feedback_name"];
    participants_count = [[jResp IntOf: @"client_feedbacks[i].participants_count"] intValue];
    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/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}"
    }
  ]
}