Query Application QoS Aggregates (v2.0)
POST/sdwan/v2.0/api/monitor/aggregates/application/qos
Query all the pplication QoS aggregates.
Request
- application/json
Body
Filters for application qos aggregates
- Array [
- ]
aggregates AggregateMetric[]required
The aggregate number of supported app stats. Max number = 10.
The name of the aggregate metric.
QoS application aggregate statistics.
The unit.
The end time to get the app stats.
filter ApplicationQosMetricsFilterrequired
Filters according to the specifications.
Filter by the name of the application.
Possible values: [Ingress
, Egress
]
Filter by the traffic direction.
Filter by the email address.
Filter by the site.
Filter by user.
The description of the app. Maz size = 128.
The start time to get the app statistics.
view Viewrequired
View the QoS metric details.
Possible values: [ELEMENT
, INTERFACE
, CELLULAR_MODULE
, DIRECTION
, SITE
, APP
, PATH
, PATH_TYPE
, WANINTERFACE
, PRIORITY
, TRAFFIC_TYPE
, COMMON
, CLIENT_MAC_ADDRESS
, USER
, USER_EMAIL
, RESOLUTION_QUALITY
, None
]
The individual view values.
The summary of the view.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
aggregates Aggregate[]required
The application QoS aggregates.
data AggregateData[]required
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
Field
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
Operator
QoS application aggregate statistics.
The unit.
{
"aggregates": [
{
"data": [
{
"value": 0,
"view": {}
}
],
"field": "string",
"name": "string",
"operator": "max",
"statistic": "string",
"unit": "string"
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "REQUIRED_PROPERTY"
},
{
"code": "INVALID_STATS_REQUEST_BODY"
},
{
"code": "INVALID_FILTER"
},
{
"code": "APPLICATION_NOT_SUPPORTED"
},
{
"code": "MULTIPLE_QOS_TYPE_NOT_SUPPORTED"
},
{
"code": "REQUESTED_METRIC_NOT_SUPPORTED"
},
{
"code": "REQUESTED_METRIC_UNIT_NOT_SUPPORTED"
},
{
"code": "REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED"
},
{
"code": "REQUESTED_VIEW_NOT_SUPPORTED"
},
{
"code": "START_TIME_GREATER_THAN_END_TIME"
},
{
"code": "OTHER_METRICS_NOT_SUPPORTED"
},
{
"code": "REQUESTED_VIEW_NOT_SUPPORTED_FOR_METRIC"
},
{
"code": "SERVICE_UNAVAILABLE"
}
]
}
}