Query Monitor Metrics (v2.3)
POST/sdwan/v2.3/api/monitor/metrics
Query all the monitor metrics.
Request
- application/json
Body
Details of monitor metrics query
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
The end time to get the monitor metrics.
filter MonitorMetricsFilterrequired
Filters according to the specifications.
The anynet link ID.
The app for the metrics.
Possible values: [Ingress
, Egress
]
The direction of the traffic.
The element.
Path of the filter.
Possible values: [public_direct
, public_vpn
, private_direct
, private_vpn
, unknown
, servicelink
]
The path type.
The remote site.
The site.
Sprid
The WAN interface of the network.
Possible values: [TEN_SEC
, ONE_MIN
, FIVE_MIN
, ONE_HOUR
, ONE_DAY
]
The time period of the monitor metrics query.
The max data points.
metrics Metrics[]required
The details of the metrics.
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 description of the monitor metric. Maz size = 128.
The start time to get the monitor metrics.
view Viewrequired
View the monitor 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 [
- Array [
- Array [
- ]
- ]
- ]
- ]
metrics Metrics[]required
The details of the metrics.
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.
{
"metrics": [
{
"series": [
{
"data": [
{
"datapoints": [
{
"duration": "2023-12-06T03:39:48.588Z",
"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
- Array [
- ]
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_REQUEST_ERROR_0001"
},
{
"code": "EMPTY_REQ_BODY"
},
{
"code": "SCHEMA_MISMATCH"
},
{
"code": "METRIC_NOT_SUPPORTED"
},
{
"code": "METRIC_UNIT_NOT_SUPPORTED"
},
{
"code": "UNSUPPORTED_FILTER_FOR_VERSION"
},
{
"code": "UNSUPPORTED_INDIVIDUAL_DIMENSION"
},
{
"code": "VIEW_DIRECTION_AND_FILTER_DIRECTION_NOT_SUPPORTED"
},
{
"code": "UNSUPPORTED_DIRECTION_FILTER"
},
{
"code": "METRIC_AND_VIEW_NOT_SUPPORTED"
},
{
"code": "MISSING_DIRECTION"
},
{
"code": "MAX_DATAPOINTS_END_TIME"
},
{
"code": "START_TIME_GREATER_THAN_END_TIME"
},
{
"code": "METRIC_STATISTICS_NOT_SUPPORTED"
},
{
"code": "PATH_AND_PATH_TYPE_NOT_SUPPORTED"
},
{
"code": "SITE_WITH_PATH_MISSING"
},
{
"code": "SITE_WITH_WANINTERFACE_MISSING"
},
{
"code": "WANINTERFACE_WITH_ANYNETLINK_MISSING"
},
{
"code": "SITE_WITH_ELEMENT_MISSING"
},
{
"code": "METRIC_MISSING_SITE"
},
{
"code": "METRIC_MISSING_APP"
},
{
"code": "METRIC_SUPPORTS_SINGLE_SITE"
},
{
"code": "METRIC_SUPPORTS_SINGLE_REMOTE_SITE"
},
{
"code": "METRIC_SUPPORTS_SINGLE_APP"
},
{
"code": "METRIC_NOT_SUPPORTED_WITH_PATH_FILTER"
},
{
"code": "METRIC_NOT_SUPPORTED_WITH_WAN_INTERFACE"
},
{
"code": "METRIC_MISSING_PATH_ID"
},
{
"code": "METRIC_SUPPORTS_SINGLE_PATH_ID"
},
{
"code": "METRIC_SUPPORTS_SINGLE_FILTER_WITH_LIST"
}
]
}
}