Get flow time series statistics filtered by traffic type, flow type, and time range

get

http://127.0.0.1:8080/stats/timeseries/flow

Retrieves flow time series statistics for one or more appliances. Returns COLUMN_DEF (field names) and DATA (statistics arrays by appliance). When nePk is provided, returns stats for that appliance; when groupPk is provided without nePk, returns stats for all appliances in the 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.

startTime

int64

required

Unix timestamp (seconds since EPOCH) for the start of the time range. Required unless 'latest' is specified.

endTime

int64

required

Unix timestamp (seconds since EPOCH) for the end of the time range. Must be greater than startTime.

granularity

string

enum

required

Data aggregation interval. Determines the time bucket size for statistics.

Allowed:

groupPk

string

Internal group ID to retrieve stats for all appliances in a group. Used when nePk is not provided.

trafficType

string

enum

required

Filter by traffic optimization category. Maps to internal values: OPTIMIZED_TRAFFIC=1, PASS_THROUGH_SHAPED=2, PASS_THROUGH_UNSHAPED=3, ALL_TRAFFIC=4.

Allowed:

flowType

string

enum

required

Filter by TCP acceleration status. TCP_ACCELERATED=1, TCP_NOT_ACCELERATED=2, NON_TCP=3.

Allowed:

limit

integer

≤ 10000

Defaults to 10000

Maximum number of statistics records to return. Default and maximum are both 10000.

format

string

enum

Output format. Use 'csv' for CSV download with Excel-compatible format.

Allowed:

boolean

Defaults to false

When true, groups stats by IP address instead of internal appliance ID. Default is false.

latest

integer

≥ 1

Retrieve stats for the last N minutes. Overrides startTime and endTime when provided.

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 role 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

200Flow time series statistics retrieved successfully

400Bad Request - Invalid parameters. Causes: missing required parameters, invalid granularity/flowType/trafficType values, endTime less than startTime, or invalid nePk/groupPk.