Query QoS Metrics (v2.0)
Query the time series data for QOS statistics.
- application/json
Request Body
Details of qos metrics query
- end_time date required
The end time to get the QoS metrics.
filter QosMetricsFilter required
Filters according to the specifications.
direction string requiredPossible values: [
Ingress
,Egress
]The direction of the traffic.
element string[] requiredThe element.
priority string[] requiredPriority level set for the QoS metric filter.
site string[] requiredThe sites.
traffic_type string[] requiredThe traffic type for the QoS metric.
waninterface string[] requiredThe WAN interface of the network.
- interval string required
Possible values: [
TEN_SEC
,ONE_MIN
,FIVE_MIN
,ONE_HOUR
,ONE_DAY
]The time period of the QoS query.
- max_datapoints int32 required
The max data points.
metrics Metrics[] required
Metrics: Valid ListObject(allowDuplicate = true, allowEmpty = false, allowNull = false, listMaxSize = 0, error = INVALID_FILTER: Schema check failed - Invalid value for param {}, required = true)
Array [series Series[] required
Information on the series schema.
Array [data Data[] required
Data
Array [datapoints Datapoints[] required
Datapoints
Array [duration date-time requiredThe date and time of the series.
filter_property_id string requiredThe filter property ID.
links string[] requiredLinks
sites string[] requiredThe sites.
value number requiredThe values of the filter.
]statistics object requiredStatistics
]interval string requiredThe interval time.
name string requiredThe name.
unit string requiredUnit
view object requiredView the active series details.
]]- name string required
The description of the QoS metric. Maz size = 128.
- start_time date required
The start time to get the QoS metrics.
view View required
View the QoS metric details.
individual string requiredPossible values: [
ELEMENT
,INTERFACE
,CELLULAR_MODULE
,DIRECTION
,SITE
,APP
,PATH
,PATH_TYPE
,WANINTERFACE
,PRIORITY
,TRAFFIC_TYPE
,COMMON
,CLIENT_MAC_ADDRESS
,None
]The individual view values.
summary boolean requiredThe summary of the view.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
metrics Metrics[] required
The details of the metrics.
Array [series Series[] required
Information on the series schema.
Array [data Data[] required
Data
Array [datapoints Datapoints[] required
Datapoints
Array [duration date-time requiredThe date and time of the series.
filter_property_id string requiredThe filter property ID.
links string[] requiredLinks
sites string[] requiredThe sites.
value number requiredThe values of the filter.
]statistics object requiredStatistics
]interval string requiredThe interval time.
name string requiredThe name.
unit string requiredUnit
view object requiredView the active series details.
]]
{
"metrics": [
{
"series": [
{
"data": [
{
"datapoints": [
{
"duration": "2023-05-27T04:01:43.711Z",
"filter_property_id": "string",
"links": [
"string"
],
"sites": [
"string"
],
"value": 0
}
],
"statistics": {}
}
],
"interval": "string",
"name": "string",
"unit": "string",
"view": {}
}
]
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "REQUIRED_PROPERTY"
},
{
"code": "INVALID_FILTER"
},
{
"code": "MAX_DATAPOINTS_NOT_SUPPORTED"
},
{
"code": "REQUESTED_VIEW_NOT_SUPPORTED"
},
{
"code": "START_TIME_GREATER_THAN_END_TIME"
},
{
"code": "REQUESTED_METRIC_NOT_SUPPORTED"
},
{
"code": "REQUESTED_METRIC_UNIT_NOT_SUPPORTED"
},
{
"code": "REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED"
},
{
"code": "INVALID_STATS_REQUEST_BODY"
}
]
}
}