mos_scores¶
Overview¶
API to get reports for MOS Scores (bandwidth is in Kbps and data is in KB)
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/reports/
Schemes : HTTP
Tags¶
- mos_scores : Operations related to mos_scores
Paths¶
Get operation for mos_scores¶
GET /mos_scores
Description¶
Use this operation to get a report for MOS Scores. The response payload also contains the meta_data block.
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | mos_scores_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- mos_scores
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
average_virtual_wan_mos¶
The worst average quality score for an application during the time period measured using a scale of 1-5
Type : integer
lowest_virtual_wan_mos¶
The worst quality score for an application during the time period measured using a scale of 1-5
Type : integer
mos_scores_delete_success_schema¶
| Name | Schema |
|---|---|
| mos_scores optional |
mos_scores |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
mos_scores_post_success_schema¶
| Name | Schema |
|---|---|
| mos_scores optional |
mos_scores |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
mos_scores_put_success_schema¶
| Name | Schema |
|---|---|
| mos_scores optional |
mos_scores |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
mos_scores_response_schema¶
Type : < mos_scores_response_schema > array
| Name | Schema |
|---|---|
| average_virtual_wan_mos optional |
average_virtual_wan_mos |
| lowest_virtual_wan_mos optional |
lowest_virtual_wan_mos |
| name optional |
name |
| region_name optional |
region_name |
| site_name optional |
site_name |
| virtual_service optional |
virtual_service |
name¶
The MOS Score name
Type : string
region_name¶
The region name
Type : string
site_name¶
The site name
Type : string
virtual_service¶
The Virtual Path name
Type : string