Zoom Public API Documentation
Get meeting quality scores
GET {{baseUrl}}/metrics/quality?from=<date>&to=<date>&type=meeting
Use this API to return meeting quality score 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). Prerequisites:
* A Business or a higher plan. Scopes: Rate Limit Label: dashboard_home:read:admin,dashboard:read:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
from
|
string | (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. | |
to
|
string | (Required) End date. | |
type
|
string | The type of meeting quality score to query: * `meeting` — Query by meetings. * `participants` — Query by meeting participants. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"from": "<date>",
"quality": {
"audio": {
"bad": "<integer>",
"fair": "<integer>",
"good": "<integer>",
"poor": "<integer>"
},
"screen_share": {
"bad": "<integer>",
"fair": "<integer>",
"good": "<integer>",
"poor": "<integer>"
},
"video": {
"bad": "<integer>",
"fair": "<integer>",
"good": "<integer>",
"poor": "<integer>"
}
},
"to": "<date>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/metrics/quality?from=<date>&to=<date>&type=meeting?from=<date>&to=<date>&type=meeting' -H 'Accept: application/json'
ENDPOINTS