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:
dashboard_home:read:admin
,
dashboard:read:admin
Rate Limit Label
:
Heavy
Request Params
| 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":"\u003cdate\u003e","quality":{"audio":{"bad":"\u003cinteger\u003e","fair":"\u003cinteger\u003e","good":"\u003cinteger\u003e","poor":"\u003cinteger\u003e"},"screen_share":{"bad":"\u003cinteger\u003e","fair":"\u003cinteger\u003e","good":"\u003cinteger\u003e","poor":"\u003cinteger\u003e"},"video":{"bad":"\u003cinteger\u003e","fair":"\u003cinteger\u003e","good":"\u003cinteger\u003e","poor":"\u003cinteger\u003e"}},"to":"\u003cdate\u003e"}