Query Application QOS Aggregates (2.0)

POST 
/v2.0/api/tenants/:tenant_id/monitor/aggregates/application/qos

The aggregated data for an application's QOS stats.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Filters for application qos aggregates

aggregates AggregateMetric[]required
The aggregate number of supported app stats. Max number = 10.
Array [
name stringrequired
The name of the aggregate metric.
statistic stringrequired
QoS application aggregate statistics.
unit stringrequired
The unit.
]
end_time date

The end time to get the app stats.

filter ApplicationQosMetricsFilterrequired

Filters according to the specifications.

application_name stringrequired

Filter by the name of the application.

direction string

Possible values: [Ingress, Egress]

Filter by the traffic direction.

email string[]

Filter by the email address.

site string[]

Filter by the site.

user string[]

Filter by user.

name string

The description of the app. Maz size = 128.

start_time date

The start time to get the app statistics.

view View

View the QoS 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

aggregates Aggregate[]
The application QoS aggregates.
Array [
data AggregateData[]
The details of the aggregate data.
Array [
value number
Value of the aggregate data.
view object
View the aggregate date.
]
field string
Field
name string
The name of the query response.
operator string
Possible values: [max, count, min, avg, sum]
Operator
statistic string
QoS application aggregate statistics.
unit string
The unit.
]

Example (from schema)

{
  "aggregates": [
    {
      "data": [
        {
          "value": 0,
          "view": {}
        }
      ],
      "field": "string",
      "name": "string",
      "operator": "max",
      "statistic": "string",
      "unit": "string"
    }
  ]
}

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": "REQUIRED_PROPERTY"
      },
      {
        "code": "INVALID_STATS_REQUEST_BODY"
      },
      {
        "code": "INVALID_FILTER"
      },
      {
        "code": "APPLICATION_NOT_SUPPORTED"
      },
      {
        "code": "MULTIPLE_QOS_TYPE_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_METRIC_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_METRIC_UNIT_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_METRIC_STATISTICS_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_VIEW_NOT_SUPPORTED"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "OTHER_METRICS_NOT_SUPPORTED"
      },
      {
        "code": "REQUESTED_VIEW_NOT_SUPPORTED_FOR_METRIC"
      },
      {
        "code": "SERVICE_UNAVAILABLE"
      }
    ]
  }
}

Loading...