Query LQM Point Metrics (v2.0)
POST/sdwan/v2.0/api/monitor/lqm_point_metrics
Query all the link quality point metrics.
Request
- application/json
Body
Query request for getting lqm metrics
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
The end time of the point metrics query. End times need to be specified in ISO8601 UTC format.
filter Filterrequired
Filters according to the specifications.
Elements of the filter.
Path of the filter.
Site of the filter.
Type of the filter.
Possible values: [TEN_SEC
, ONE_MIN
, FIVE_MIN
, ONE_HOUR
, ONE_DAY
]
The interval time.
metrics Metrics[]required
The details of the point metric. Metrics need to specified according to 2.0 specifications. Invalid metrics will be ignored and the result will not include them.
series Series[]required
Information on the series schema.
data Data[]required
Data
datapoints Datapoints[]required
Datapoints
The date and time of the series.
The filter property ID.
Links
The sites.
The values of the filter.
Statistics
The interval time.
The name.
Unit
View the active series details.
The name of the point metric. Maz size = 128.
The start time to get the point metrics. Start times need to be specified in ISO8601 UTC format.
view Viewrequired
View
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
The time period of the query interval.
The details of the point metric. Metrics need to specified according to 2.0 specifications. Invalid metrics will be ignored and the result will not include them.
The start time to get the point metrics. Start times need to be specified in ISO8601 UTC format.
view Viewrequired
The individual and summary views.
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.
{
"interval": "string",
"metrics": {},
"start_time": "2023-12-01",
"view": {
"individual": "ELEMENT",
"summary": true
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_REQUEST_ERROR_0001"
},
{
"code": "SCHEMA_MISMATCH"
},
{
"code": "METRIC_NOT_SUPPORTED"
},
{
"code": "FUTURE_TIME_ERROR"
}
]
}
}