Get App Stats Aggregates (v3.0)

List all the supported app stats aggregates.

application/json

Request Body

Filters and Metrics for Aggregating App stats

aggregates AppStatsAggregate[] required
The aggregate number of supported app stats. Max number = 10.
Array [
name string required
Possible values: [WanCapacity, PolicyDataTrafficVolume, PolicyDataAppThroughput, WanEngineering, PrefixList]
The name of the aggregate value.
unit string required
Unit
]
end_time date required
The end time to get the app stats.
filter AppStatsAggregateFilter required
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 required
The description of the app. Maz size = 128.
start_time date required
The start time to get the app statistics.

Responses

Successful Operation

application/json

Schema
Example (from schema)

Schema

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

{
  "aggregates": [
    {
      "data": {},
      "end_time": "string",
      "name": "WanCapacity",
      "start_time": "string",
      "unit": "string"
    }
  ],
  "end_time": "string",
  "start_time": "string"
}

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

Get App Stats Aggregates (v3.0)​

Get App Stats Aggregates (v3.0)