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

end_time daterequired

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 string[]required

Elements of the filter.

path string[]required

Path of the filter.

site objectrequired

Site of the filter.

type string

Type of the filter.

interval stringrequired

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.
Array [
series Series[]required
Information on the series schema.
Array [
data Data[]required
Data
Array [
datapoints Datapoints[]required
Datapoints
Array [
duration date-timerequired
The date and time of the series.
filter_property_id stringrequired
The filter property ID.
links string[]required
Links
sites string[]required
The sites.
value numberrequired
The values of the filter.
]
statistics objectrequired
Statistics
]
interval stringrequired
The interval time.
name stringrequired
The name.
unit stringrequired
Unit
view objectrequired
View the active series details.
]
]
name stringrequired

The name of the point metric. Maz size = 128.

start_time daterequired

The start time to get the point metrics. Start times need to be specified in ISO8601 UTC format.

view Viewrequired

View

individual stringrequired

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.

summary booleanrequired

The summary of the view.

Responses

200

Successful Operation

application/json

Schema

Schema

interval stringrequired

The time period of the query interval.

metrics objectrequired

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.

start_time daterequired

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.

individual stringrequired

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.

summary booleanrequired

The summary of the view.

Example (from schema)

{
  "interval": "string",
  "metrics": {},
  "start_time": "2023-12-01",
  "view": {
    "individual": "ELEMENT",
    "summary": true
  }
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "METRIC_NOT_SUPPORTED"
      },
      {
        "code": "FUTURE_TIME_ERROR"
      }
    ]
  }
}

Loading...