Get aggregated traffic class statistics filtered by query parameters

get

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

Retrieves aggregated traffic class statistics for a single appliance or group of appliances. Response structure varies based on query parameters. Use nePk for single appliance stats, groupPk for group stats, or omit both for all appliances.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

groupPk

string

Group primary key to filter appliances. Used when nePk is not provided to retrieve stats for all appliances in a group.

startTime

int64

required

≥ 0

EPOCH timestamp (milliseconds) for the start of the data time range. Must be >= 0 and less than endTime.

endTime

int64

required

≥ 0

EPOCH timestamp (milliseconds) for the end of the data time range. Must be >= 0 and greater than startTime.

granularity

string

enum

required

Time interval granularity for data aggregation. Determines whether stats are aggregated by minute, hour, or day.

Allowed:

trafficClass

integer

enum

1 to 10

Filter statistics by traffic class (QoS priority level). Valid range: 1-10, where 1 is highest priority.

trafficType

string

enum

Filter by traffic optimization type. 'optimized_traffic' for WAN-optimized flows, 'pass_through_shaped' for shaped pass-through, 'pass_through_unshaped' for unshaped pass-through, 'all_traffic' for combined stats.

Allowed:

groupByNE

boolean

Defaults to true

When true, groups statistics by appliance with nePk/IP as the key. Default is true.

boolean

When true, uses IP address as the grouping key instead of internal appliance ID (nePk).

metric

string

enum

Metric to sort results by. Required when using the 'top' parameter to limit results.

top

integer

≥ 1

Limits results to top N items sorted by the specified metric. Requires the 'metric' parameter to be set.

format

string

enum

Response format. When set to 'csv', returns data as a downloadable CSV file instead of JSON.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ or READ_WRITE permissions

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

200Successfully retrieved traffic class aggregate statistics. Response structure varies based on groupByNE parameter.

400Bad Request - Invalid parameters or validation failure