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

Get aggregated application bandwidth statistics for multiple appliances

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

Retrieves aggregated application bandwidth statistics for specified appliances within a time range. Each appliance is queried independently and results are returned per-appliance with column headers. If lastHour is enabled and no data exists in the specified range, the API automatically queries one hour earlier.

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

Start time boundary for the data query as a Unix EPOCH timestamp in milliseconds. Must be non-negative and less than endTime.

int64
required
≥ 0

End time boundary for the data query as a Unix EPOCH timestamp in milliseconds. Must be greater than startTime.

string

Filter results by application name. When omitted, returns statistics for all applications.

integer
≥ 1
Defaults to 10

Limit results to top N applications by throughput. When specified, returns only the highest bandwidth applications.

boolean
Defaults to false

When true, if no data is found in the specified time range, automatically fetches data from one hour prior. Useful for near-real-time dashboards.

Body Params

List of appliance identifiers to query. Only the nePk field is required; other fields are optional.

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.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

Forbidden - User lacks required READ or READ_WRITE permissions

Updated about 11 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
text/html

Updated about 11 hours ago

Did this page help you?