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

Get aggregated overlay bandwidth statistics

post
http://127.0.0.1:8080/stats2/aggregate/overlays/bandwidth

Retrieves aggregated overlay bandwidth statistics for specified appliances within a time range. Returns WAN transmit/receive and LAN transmit/receive byte counts grouped by overlay ID for each appliance. Excludes overlay ID 0 from results.

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

EPOCH timestamp (milliseconds) marking the start of the time range for statistics retrieval. Must be non-negative and less than endTime.

int64
required
≥ 0

EPOCH timestamp (milliseconds) marking the end of the time range for statistics retrieval. Must be greater than startTime.

string
enum
required

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

Allowed:
Body Params

Array of appliance-tunnel filter objects. Each entry specifies an appliance and optionally a tunnel 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?