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

Get aggregated interface overlay transport statistics

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

Retrieves aggregated interface overlay transport statistics for the specified appliances. Returns bandwidth, packet, and overhead metrics aggregated over the specified time range and granularity, grouped by interface name, label, tunnel type, and overlay ID.

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

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

int64
required
≥ 0

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

string
enum
required

Data granularity level determining which statistics table to query. Affects data resolution and aggregation.

Allowed:
string

Filter by overlay ID. Use '0' for physical tunnels only, omit for all bonded and physical tunnels, or specify an overlay ID for specific bonded tunnels.

Body Params

Array of appliance tunnel objects specifying which appliances to query for interface overlay stats.

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 12 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 12 hours ago

Did this page help you?