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

Get interface overlay transport time series statistics for a single appliance.

get
http://127.0.0.1:8080/stats/timeseries/interfaceOverlay

Retrieves interface overlay transport time series statistics for a single appliance. Returns bandwidth, packet counts, and peak metrics for interfaces filtered by overlay, tunnel type, label, and WAN/LAN side. Data is aggregated based on the specified granularity (minute, hour, or day).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

int64
required

Start time boundary in seconds since EPOCH. Must be less than endTime.

int64
required

End time boundary in seconds since EPOCH. Must be greater than startTime.

string
enum
required

Data granularity level. Determines time interval aggregation for statistics.

Allowed:
string

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

integer
enum

Tunnel type filter. Overlay types: 0=SD-WAN, 2=Breakout, 3=Services. Underlay types: 1=Underlay, 2=Pass-through, 3=Services.

Allowed:
integer

Filter by label internal ID. Used to retrieve stats for a specific interface label.

boolean
Defaults to false

Filter by WAN side (true) or LAN side (false) data. Defaults to false if not specified.

string

Filter by specific interface name (e.g., 'wan0', 'lan0').

integer
≤ 10000
Defaults to 10000

Maximum number of records to return. Default and maximum are both 10000.

Responses

401

Unauthorized - Authentication required or invalid credentials.

403

Forbidden - User lacks READ or READ_WRITE permission.

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?