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

Retrieve aggregated tunnel statistics filtered by query parameters

post
http://127.0.0.1:8080/stats3/aggregate/tunnel

Retrieves aggregated tunnel statistics for specified appliances and tunnels. Returns throughput, latency, packet loss, jitter, and other metrics. Response format varies based on groupByNE parameter.

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 range as Unix epoch timestamp in seconds. Must be greater than or equal to 0 and less than endTime.

int64
required
≥ 0

End time boundary for the data range as Unix epoch timestamp in seconds. Must be greater than startTime.

string
enum
required

Time granularity for data aggregation. Determines the resolution of statistics returned.

Allowed:
string
enum
required

Metric type to sort and aggregate stats by. Required parameter that determines which statistics columns are returned.

integer
≥ 1

Limits results to top N tunnels by the specified metric. Requires metric parameter to be set. Used for ranking tunnels by performance.

string

Filter tunnels by overlay type. Use 'all' for bonded tunnels only, '0' for physical tunnels only, specific overlay ID for tunnels in that overlay, or omit for all tunnel types.

boolean
Defaults to true

Group results by network element (appliance). When true, response includes nePk field in each stats object. Default is true.

Body Params

Array of appliance and tunnel identifiers to filter statistics. Each object specifies an appliance and optionally a specific tunnel.

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?