Get flow time series statistics for multiple appliances via POST request body

post

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

Retrieves flow time series statistics for multiple appliances specified in the request body. Returns column_def (field names array) and data (statistics arrays keyed by appliance ID). Supports both JSON response and CSV export. Validates all appliance IDs exist in GMS before processing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

startTime

int64

≥ 0

Unix timestamp (seconds since EPOCH) for time range start. Required unless 'latest' is provided. Must be >= 0.

endTime

int64

≥ 0

Unix timestamp (seconds since EPOCH) for time range end. Must be greater than startTime and >= 0.

granularity

string

enum

required

Data aggregation interval determining time bucket size. Case-insensitive (converted to uppercase internally).

Allowed:

trafficType

string

enum

required

Traffic optimization category filter. Case-insensitive. Maps to internal values: OPTIMIZED_TRAFFIC=1, PASS_THROUGH_SHAPED=2, PASS_THROUGH_UNSHAPED=3, ALL_TRAFFIC=4.

Allowed:

flowType

string

enum

required

TCP acceleration status filter. Case-insensitive. TCP_ACCELERATED=1, TCP_NOT_ACCELERATED=2, NON_TCP=3.

Allowed:

limit

integer

Maximum statistics records to return. When null, no limit is applied.

format

string

enum

Output format. Use 'csv' (case-insensitive) for CSV download with Excel-compatible format. Filename: FlowTimeSeriesStats.csv.

Allowed:

boolean

Defaults to false

When true, groups statistics by IP address instead of appliance ID. Default is false/null.

latest

integer

≥ 1

Retrieve stats for last N minutes from current time. When provided, automatically calculates: endTime=now, startTime=now-(latest*60). Overrides startTime/endTime parameters.

Body Params

JSON object containing list of appliance IDs to query. All IDs must exist in GMS or request fails.

Request body containing appliance IDs for batch statistics retrieval

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

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ or READ_WRITE role permissions. Requires Constants.READ or Constants.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

200Flow time series statistics retrieved successfully

400Bad Request - Invalid parameters