Get App Stats Aggregates (v3.0)

POST 
/v3.0/api/tenants/:tenant_id/monitor/aggregates

List all the supported app stats aggregates.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

Body

Filters and Metrics for Aggregating App stats

aggregates AppStatsAggregate[]required
The aggregate number of supported app stats. Max number = 10.
Array [
name stringrequired
Possible values: [WanCapacity, PolicyDataTrafficVolume, PolicyDataAppThroughput, WanEngineering, PrefixList]
The name of the aggregate value.
unit string
Unit
]
end_time date

The end time to get the app stats.

filter AppStatsAggregateFilter

Filters according to the specifications.

app string[]

Filter by apps.

element string[]

Filter by element.

path string[]

Filter by path.

path_type string[]

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

Filter by path type.

site string[]

Filter by site.

name string

The description of the app. Maz size = 128.

start_time date

The start time to get the app statistics.

Responses

200

Successful Operation

application/json

Schema

Schema

aggregates AppStatsAggregateData[]
The aggregate number of supported app stats. Max number = 10.
Array [
data object
The aggregate app statistics.
end_time string
The end time to get the app stats.
name string
Possible values: [WanCapacity, PolicyDataTrafficVolume, PolicyDataAppThroughput, WanEngineering, PrefixList]
The name of the aggregate value.
start_time string
The start time to get the app statistics.
unit string
Unit
]
end_time string

The end time to get the app stats.

start_time string

The start time to get the app statistics.

Example (from schema)

{
  "aggregates": [
    {
      "data": {},
      "end_time": "string",
      "name": "WanCapacity",
      "start_time": "string",
      "unit": "string"
    }
  ],
  "end_time": "string",
  "start_time": "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": "LENGTH_EXCEEDED"
      },
      {
        "code": "INVALID_FILTER"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "FUTURE_TIME_ERROR"
      },
      {
        "code": "PATH_AND_PATH_TYPE_NOT_SUPPORTED"
      },
      {
        "code": "AGGREGATE_FILTER_MANDATORY"
      },
      {
        "code": "AGGREGATE_UNIT_REQUIRED"
      },
      {
        "code": "AGGREGATE_UNIT_NOT_SUPPORTED"
      },
      {
        "code": "AGGREGATE_FILTER_PARAMETER_NOT_ALLOWED"
      },
      {
        "code": "AGGREGATE_FILTER_PARAMETER_REQUIRED"
      }
    ]
  }
}

Loading...