Get aggregated traffic class statistics for multiple appliances via POST

post

http://127.0.0.1:8080/stats/aggregate/trafficClass

Retrieves aggregated traffic class statistics for specified appliances. Use POST to query a specific set of appliances by nePk. Parameters are validated in order: metric/top dependency, granularity, trafficType, trafficClass, nePks existence, then time range.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

startTime

int64

required

≥ 0

Start of data time range in EPOCH milliseconds. Must be >= 0 and less than endTime.

endTime

int64

required

≥ 0

End of data time range in EPOCH milliseconds. Must be >= 0 and greater than startTime.

granularity

string

enum

required

Time interval for data aggregation. Case-insensitive (e.g., 'MINUTE', 'Hour').

Allowed:

trafficClass

integer

enum

1 to 10

Filter by QoS traffic class priority level (1=highest). When omitted, returns all traffic classes.

trafficType

string

enum

Filter by traffic optimization type. Case-insensitive. When omitted, returns all traffic types.

Allowed:

boolean

Defaults to false

Use IP address as grouping key instead of nePk. Affects response structure when groupByNE=true.

metric

string

enum

Metric for sorting results. Required when 'top' is specified.

top

integer

≥ 1

Return only top N results sorted by metric. Requires 'metric' parameter.

format

string

enum

Output format. Set to 'csv' for downloadable Excel-compatible file.

Allowed:

groupByNE

boolean

Defaults to true

Group statistics by appliance. When true (default), response is keyed by nePk or IP.

Body Params

List of appliance IDs (nePks) to query. All nePks must exist in GMS.

Request body containing the list of appliance identifiers.

nePks

array of objects

required

List of appliance identifiers (nePks).

nePks*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication required or invalid credentials

403

Insufficient permissions - requires READ or READ_WRITE role

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.ms-excel

200Traffic class statistics retrieved successfully. Response structure: {trafficType: {trafficClass: {nePk: stats}}}.

400Invalid parameters or validation failure