HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. aggregateStats

Retrieve aggregated flow statistics for multiple appliances

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

Returns aggregated flow statistics for a list of appliances specified in the request body. Useful for bulk queries across multiple appliances. Supports filtering by flow type, traffic type, and time granularity. Response structure varies based on groupByNE parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Time granularity for data aggregation. Valid values: minute, hour, day, month. Case-insensitive.

Allowed:
int64
required
≥ 0

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

int64
required
≥ 0

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

string
enum

Filter by flow type. TCP_ACCELERATED (1)=optimized TCP, TCP_NOT_ACCELERATED (2)=unoptimized TCP, NON_TCP (3)=UDP/other protocols. Case-sensitive.

Allowed:
string
enum

Filter by traffic classification. OPTIMIZED_TRAFFIC (1), PASS_THROUGH_SHAPED (2), PASS_THROUGH_UNSHAPED (3), ALL_TRAFFIC (4). Case-insensitive.

Allowed:
boolean
Defaults to false

When true, uses IP address as the grouping key instead of nePk in response. Default is false.

string

Metric name for top-N filtering. Required if 'top' parameter is provided.

integer
≥ 1

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

string
enum

Response format. Use 'csv' to download as CSV file with Excel-compatible headers. Default is JSON.

Allowed:
boolean
Defaults to true

When true (default), groups stats by appliance with nested structure. When false, returns flat aggregated results.

Body Params

JSON object containing list of appliance IDs to query. At least one nePk is required.

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

Updated about 14 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.ms-excel

Updated about 14 hours ago

Did this page help you?