Get System Metrics Schema (v2.2)
POST/sdwan/v2.2/api/monitor/sys_metrics
List all the system metrics schema.
Request
- application/json
Body
Query request for getting sysmetrics
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- ]
- ]
The end time to get the system metrics.
filter SysMetricsFilterrequired
Filters according to the specifications.
Possible values: [Ingress
, Egress
]
The direction of the traffic.
The element.
The configured interfaces.
The site.
Possible values: [TEN_SEC
, ONE_MIN
, FIVE_MIN
, ONE_HOUR
, ONE_DAY
]
The time period of the system 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 system metric. Maz size = 128.
The start time to get the system metrics.
view Viewrequired
View the system 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
- 500
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.586Z",
"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": "SCHEMA_MISMATCH"
},
{
"code": "METRIC_NOT_SUPPORTED"
},
{
"code": "METRIC_UNIT_NOT_SUPPORTED"
},
{
"code": "UNSUPPORTED_FILTER_IN_VERSION"
},
{
"code": "UNSUPPORTED_FILTER_FOR_METRIC"
},
{
"code": "MISSING_INTERFACE_FILTER_PROPERTY"
},
{
"code": "MISSING_ELEMENT_FILTER_PROPERTY"
},
{
"code": "UNSUPPORTED_DIRECTION_FILTER"
},
{
"code": "DIRECTION_FILTER_EMPTY"
},
{
"code": "DIRECTION_VIEW_NOT_SUPPORTED"
},
{
"code": "MAX_DATAPOINTS_END_TIME"
}
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}