Query Interface Stats (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/monitor/agg_bw_stats

Query interface bandwidth usage. Start_time, end_time and max_datapoints are optional with the following restrictions, at least one of them needs to be specified. All the three can not be specified, as the result is ambiguous. Start time, if not specified, defaults to epoch. End time, if not specified, defaults to now. Limit, if not specified, defaults to None. Start and end times need to be specified in ISO8601 UTC format.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Query request for getting sysmetrics

end_time date

The end time to get the system metrics.

filter AggregateBWStatsFilter

Filters according to the specifications.

site string[]

Site

interval stringrequired

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

The interval time.

max_datapoints int32

The max datapoints of the system metrics.

metrics Metrics[]required
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 name of the system metric.

start_time date

The start time to get the system metrics.

view View

View the system metrics.

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[]
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": "SCHEMA_MISMATCH"
      },
      {
        "code": "METRIC_NOT_SUPPORTED"
      },
      {
        "code": "METRIC_UNIT_NOT_SUPPORTED"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "MAX_DATAPOINTS_END_TIME"
      },
      {
        "code": "MAX_DATAPOINTS_NOT_SUPPORTED"
      },
      {
        "code": "INVALID_STATS_REQUEST_BODY"
      },
      {
        "code": "REQUESTED_VIEW_NOT_SUPPORTED"
      },
      {
        "code": "AGGREGATE_BW_STATS_VIEW_INDIVIDUAL_NOT_SUPPORTED"
      }
    ]
  }
}

500

Internal Server Error

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"
    }
  ]
}

Loading...