Retrieve aggregated flow statistics

get

http://127.0.0.1:8080/stats/aggregate/flow

Returns aggregated flow statistics for a single appliance or a group of appliances. Response structure varies based on groupByNE parameter. When nePk is provided, returns stats for that specific appliance; otherwise queries all appliances or those in the specified group.

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 query multiple appliances in a group.

granularity

string

enum

required

Time granularity for data aggregation. Determines the resolution of returned statistics.

Allowed:

startTime

int64

required

≥ 0

Start of time range as Unix epoch timestamp in milliseconds. Must be >= 0 and less than endTime.

endTime

int64

required

≥ 0

End of time range as Unix epoch timestamp in milliseconds. Must be >= 0 and greater than startTime.

flowType

string

enum

Filter by flow type category. TCP_ACCELERATED=optimized TCP flows, TCP_NOT_ACCELERATED=unoptimized TCP, NON_TCP=UDP and other protocols.

Allowed:

trafficType

string

enum

Filter by traffic classification type. Controls which traffic category statistics are returned.

Allowed:

boolean

Defaults to false

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

format

string

enum

Response format. Use 'csv' for CSV file download with Excel-compatible headers.

Allowed:

groupByNE

boolean

Defaults to true

When true, groups stats by appliance with an extra nesting level. Default is true when not specified.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

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 flow aggregate statistics

400Bad request - invalid or missing parameters

401Unauthorized - authentication required

403Forbidden - insufficient permissions. Requires READ or READ_WRITE role.