Chilkat Online Tools

Node.js / Zoom API / Get meeting quality scores

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("from","1989-05-07");
    queryParams.UpdateString("to","1989-05-07");
    queryParams.UpdateString("type","meeting");

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

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/quality",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

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

    // {
    //   "from": "2019-02-28",
    //   "to": "2019-03-28",
    //   "quality": [
    //     {
    //       "audio": {
    //         "good": 13,
    //         "fair": 2,
    //         "poor": 1,
    //         "bad": 0
    //       },
    //       "video": {
    //         "good": 16,
    //         "fair": 0,
    //         "poor": 0,
    //         "bad": 0
    //       },
    //       "screen_share": {
    //         "good": 6,
    //         "fair": 4,
    //         "poor": 3,
    //         "bad": 3
    //       }
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var Good;
    var Fair;
    var Poor;
    var Bad;
    var videoGood;
    var videoFair;
    var videoPoor;
    var videoBad;
    var screen_shareGood;
    var screen_shareFair;
    var screen_sharePoor;
    var screen_shareBad;

    var from = jResp.StringOf("from");
    var v_to = jResp.StringOf("to");
    var i = 0;
    var count_i = jResp.SizeOfArray("quality");
    while (i < count_i) {
        jResp.I = i;
        Good = jResp.IntOf("quality[i].audio.good");
        Fair = jResp.IntOf("quality[i].audio.fair");
        Poor = jResp.IntOf("quality[i].audio.poor");
        Bad = jResp.IntOf("quality[i].audio.bad");
        videoGood = jResp.IntOf("quality[i].video.good");
        videoFair = jResp.IntOf("quality[i].video.fair");
        videoPoor = jResp.IntOf("quality[i].video.poor");
        videoBad = jResp.IntOf("quality[i].video.bad");
        screen_shareGood = jResp.IntOf("quality[i].screen_share.good");
        screen_shareFair = jResp.IntOf("quality[i].screen_share.fair");
        screen_sharePoor = jResp.IntOf("quality[i].screen_share.poor");
        screen_shareBad = jResp.IntOf("quality[i].screen_share.bad");
        i = i+1;
    }


}

chilkatExample();

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get meeting quality scores",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/metrics/quality?from=1989-05-07&to=1989-05-07&type=meeting",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "metrics",
        "quality"
      ],
      "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."
        },
        {
          "key": "type",
          "value": "meeting",
          "description": "The type of meeting quality score to query: \n* `meeting` — Query by meetings. \n* `participants` — Query by meeting participants."
        }
      ]
    },
    "description": "Use this API to return [meeting quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Meeting-quality-scores-and-network-alerts-on-Dashboard) information. Meeting quality scores are based on the mean opinion score (MOS). The MOS measures a meeting's quality on a scale of \"Good\" (5-4), \"Fair\" (4-3), \"Poor\" (3-2), or \"Bad\" (2-1). \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 a higher plan."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nMeeting quality returned",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/metrics/quality?from=1989-05-07&to=1989-05-07&type=meeting",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "metrics",
            "quality"
          ],
          "query": [
            {
              "key": "from",
              "value": "1989-05-07"
            },
            {
              "key": "to",
              "value": "1989-05-07"
            },
            {
              "key": "type",
              "value": "meeting"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"from\": \"2019-02-28\",\n \"to\": \"2019-03-28\",\n \"quality\": [\n  {\n   \"audio\": {\n    \"good\": 13,\n    \"fair\": 2,\n    \"poor\": 1,\n    \"bad\": 0\n   },\n   \"video\": {\n    \"good\": 16,\n    \"fair\": 0,\n    \"poor\": 0,\n    \"bad\": 0\n   },\n   \"screen_share\": {\n    \"good\": 6,\n    \"fair\": 4,\n    \"poor\": 3,\n    \"bad\": 3\n   }\n  }\n ]\n}"
    }
  ]
}