Query Monitor Metrics (v2.3)

Query all 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[] required
The anynet link ID.
app string[] required
The app for the metrics.
direction string required
Possible values: [Ingress, Egress]
The direction of the traffic.
element string[] required
The element.
path string[] required
Path of the filter.
path_type string[] required
Possible values: [public_direct, public_vpn, private_direct, private_vpn, unknown, servicelink]
The path type.
remote_site string[] required
The remote site.
site string[] required
The site.
sprid string required
Sprid
waninterface string[] required
The 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 required
The date and time of the series.
filter_property_id string required
The filter property ID.
links string[] required
Links
sites string[] required
The sites.
value number required
The values of the filter.
]
statistics object required
Statistics
]
interval string required
The interval time.
name string required
The name.
unit string required
Unit
view object required
View 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 required
Possible 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 required
The summary of the view.

Responses

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 required
The date and time of the series.
filter_property_id string required
The filter property ID.
links string[] required
Links
sites string[] required
The sites.
value number required
The values of the filter.
]
statistics object required
Statistics
]
interval string required
The interval time.
name string required
The name.
unit string required
Unit
view object required
View the active series details.
]
]

{
  "metrics": [
    {
      "series": [
        {
          "data": [
            {
              "datapoints": [
                {
                  "duration": "2023-06-07T22:06:21.570Z",
                  "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 string
message 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_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"
      }
    ]
  }
}

Query Monitor Metrics (v2.3)​

Query Monitor Metrics (v2.3)