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

Get aggregated application statistics

post
http://127.0.0.1:8080/stats2/aggregate/application

Retrieves aggregated application bandwidth statistics for multiple appliances. Returns LAN/WAN byte and packet counts grouped by appliance. When ip parameter is true, appliance IP addresses are included in the response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
required
≥ 0

Start of time range as Unix epoch timestamp in milliseconds. Must be less than endTime and non-negative.

int64
required
≥ 0

End of time range as Unix epoch timestamp in milliseconds. Must be greater than startTime and non-negative.

string
enum
required

Data aggregation granularity. Determines which statistics table is queried (minute, hourly, or daily).

Allowed:
string

Filter results to a specific application name. When omitted, returns stats for all applications.

string
enum

Filter by traffic optimization type. Values map to: optimized_traffic(1), pass_through_shaped(2), pass_through_unshaped(3), all_traffic(4).

Allowed:
boolean
Defaults to false

When true, includes appliance IP address in response instead of using only nePk as identifier. Default is false.

string
enum

Metric to sort results by. Required when using 'top' parameter. Currently supports 'throughput' which sorts by total LAN bytes (LRX + LTX).

Allowed:
integer
≥ 1

Limit results to top N applications by the specified metric. Requires 'metric' parameter. Returns top+1 results.

Body Params

Array of appliance tunnel identifiers to query statistics for. Each object must contain a valid nePk.

Array of appliance-tunnel filter objects. Each entry specifies an appliance and optionally a tunnel to retrieve statistics for.

Identifies an appliance and optionally a specific tunnel for statistics retrieval.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE'.

string | null

Specific tunnel identifier to filter. If null or not provided, returns stats for all tunnels on the appliance (excluding 'all traffic' and 'optimized traffic').

string | null

Orchestrator tunnel ID. Required when isRemote is true to identify the remote tunnel.

boolean
Defaults to false

Indicates if querying for a remote tunnel. When true, orchTid must be provided. Stats are retrieved from peer appliances.

Responses

Updated about 13 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

Updated about 13 hours ago

Did this page help you?