Query Monitor Metrics (v2.1)
Query the monitor metrics.
- application/json
Request Body
Details of monitor metrics query
- end_time date required
The end time to get the monitor metrics.
filter MonitorMetricsFilter required
Filters according to the specifications.
anynet_link string[] requiredThe anynet link ID.
app string[] requiredThe app for the metrics.
direction string requiredPossible values: [
Ingress
,Egress
]The direction of the traffic.
element string[] requiredThe element.
path string[] requiredPath of the filter.
path_type string[] requiredPossible values: [
public_direct
,public_vpn
,private_direct
,private_vpn
,unknown
,servicelink
]The path type.
remote_site string[] requiredThe remote site.
site string[] requiredThe site.
sprid string requiredSprid
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 monitor metrics query.
- max_datapoints int32 required
The max data points.
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.
]]- name string required
The description of the monitor metric. Maz size = 128.
- start_time date required
The start time to get the monitor metrics.
view View required
View the monitor 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.718Z",
"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": "INVALID_REQUEST_ERROR_0001"
},
{
"code": "EMPTY_REQ_BODY"
},
{
"code": "SCHEMA_MISMATCH"
},
{
"code": "METRIC_NOT_SUPPORTED"
},
{
"code": "METRIC_UNIT_NOT_SUPPORTED"
},
{
"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"
}
]
}
}