autoit / Zoom API / Get meeting quality scores
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("from","1989-05-07")
$oQueryParams.UpdateString("to","1989-05-07")
$oQueryParams.UpdateString("type","meeting")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/quality",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $iGood
Local $iFair
Local $iPoor
Local $iBad
Local $iVideoGood
Local $iVideoFair
Local $iVideoPoor
Local $iVideoBad
Local $iScreen_shareGood
Local $iScreen_shareFair
Local $iScreen_sharePoor
Local $iScreen_shareBad
Local $sFrom = $oJResp.StringOf("from")
Local $sV_to = $oJResp.StringOf("to")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("quality")
While $i < $iCount_i
$oJResp.I = $i
$iGood = $oJResp.IntOf("quality[i].audio.good")
$iFair = $oJResp.IntOf("quality[i].audio.fair")
$iPoor = $oJResp.IntOf("quality[i].audio.poor")
$iBad = $oJResp.IntOf("quality[i].audio.bad")
$iVideoGood = $oJResp.IntOf("quality[i].video.good")
$iVideoFair = $oJResp.IntOf("quality[i].video.fair")
$iVideoPoor = $oJResp.IntOf("quality[i].video.poor")
$iVideoBad = $oJResp.IntOf("quality[i].video.bad")
$iScreen_shareGood = $oJResp.IntOf("quality[i].screen_share.good")
$iScreen_shareFair = $oJResp.IntOf("quality[i].screen_share.fair")
$iScreen_sharePoor = $oJResp.IntOf("quality[i].screen_share.poor")
$iScreen_shareBad = $oJResp.IntOf("quality[i].screen_share.bad")
$i = $i + 1
Wend
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}"
}
]
}
