Query Monitor Metrics (v2.5)

POST 
/v2.5/api/tenants/:tenant_id/monitor/metrics

Query all the monitor metrics.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Details of monitor metrics query

end_time date

The end time to get the monitor metrics.

filter MonitorMetricsFilter

Filters according to the specifications.

anynet_link string[]

The anynet link ID.

app string[]

The app for the metrics.

direction string

Possible values: [Ingress, Egress]

The direction of the traffic.

element string[]

The element.

path string[]

Path of the filter.

path_type string[]

Possible values: [public_direct, public_vpn, private_direct, private_vpn, unknown, servicelink]

The path type.

probe_config string[]

Probe Config

remote_site string[]

The remote site.

site string[]

The site.

sprid string

Sprid

waninterface string[]

The WAN interface of the network.

interval stringrequired

Possible values: [10sec, 1min, 5min, 1hour, 1day, 1month]

The time period of the monitor metrics query.

max_datapoints int32

The max data points.

metrics Metrics[]required
The details of the metrics.
Array [
name stringrequired
Name: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) Pattern(error = INVALID_FILTER: Schema check failed - Invalid value for param {}, regexp = ^[A-Za-z]+$)
statistics string[]required
Statistics: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property)
unit stringrequired
Unit: Required(error = REQUIRED_PROPERTY: Schema check failed - {} is a required property) Pattern(error = INVALID_FILTER: Schema check failed - Invalid value for param {}, regexp = ^[A-Za-z]+$)
]
name string

The description of the monitor metric. Maz size = 128.

start_time date

The start time to get the monitor metrics.

view View

View the monitor metric details.

individual string

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 boolean

The summary of the view.

Responses

200

Successful Operation

application/json

Schema

Schema

metrics MetricArray[]
The details of the metrics.
Array [
series Series[]
Series
Array [
data Data[]
Data
Array [
datapoints Datapoints[]
Datapoints
Array [
duration date-time
The date and time of the series.
filter_property_id string
The filter property ID.
links string[]
Links
max_value_time date-time
ninetieth_percentile number
Ninetieth Percentile
sites string[]
The sites.
value number
The values of the filter.
]
statistics object
Statistics
]
interval string
The interval time.
name string
The name.
unit string
Unit
view object
View the active series details.
]
]

Example (from schema)

{
  "metrics": [
    {
      "series": [
        {
          "data": [
            {
              "datapoints": [
                {
                  "duration": "2024-07-29T15:51:28.071Z",
                  "filter_property_id": "string",
                  "links": [
                    "string"
                  ],
                  "max_value_time": "2024-07-29T15:51:28.071Z",
                  "ninetieth_percentile": 0,
                  "sites": [
                    "string"
                  ],
                  "value": 0
                }
              ],
              "statistics": {}
            }
          ],
          "interval": "string",
          "name": "string",
          "unit": "string",
          "view": {}
        }
      ]
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

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

Example

{
  "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"
      },
      {
        "code": "FILTER_NOT_SUPPORTED_FOR_METRIC"
      }
    ]
  }
}

Loading...