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

Retrieve aggregated tunnel statistics

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

Retrieves aggregated tunnel statistics for specified appliances and tunnels. Pass a request body containing appliance-tunnel pairs to filter results. Response format varies based on query parameters.

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

EPOCH timestamp (seconds) for the start of the data time range. Must be non-negative and less than endTime.

int64
required
≥ 0

EPOCH timestamp (seconds) for the end of the data time range. Must be greater than startTime.

string
enum
required

Time granularity for data aggregation. Determines which statistics table is queried.

Allowed:
string
enum

Metric to sort and filter results by. Required when using 'top' parameter. Determines which statistics columns are included in response.

integer
≥ 1

Limit results to top N tunnels by the specified metric. Requires 'metric' parameter to be set.

string

Filter by overlay ID. Use 'all' for all bonded tunnels, '0' for physical tunnels only, or a specific overlay ID for bonded tunnels associated with that overlay. Omit to return all tunnels.

boolean
Defaults to true

Group statistics by appliance (network element). When true, response includes nePk in each stats object. Default: true.

Body Params

Array of appliance-tunnel pairs specifying which tunnels to retrieve statistics for.

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 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

Updated about 11 hours ago

Did this page help you?