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

Retrieve aggregated interface overlay transport statistics

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

Retrieves aggregated interface overlay transport statistics for specified appliances within a time range. Supports filtering by overlay ID and output format (JSON or CSV). Results include bandwidth metrics, packet counts, and protocol overhead data grouped by interface and overlay.

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

Start of the time range as Unix epoch timestamp in seconds. Must be non-negative and less than endTime.

int64
required
≥ 0

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

string
enum
required

Time granularity for data aggregation. Determines which stats table is queried (minute, hourly, or daily).

Allowed:
string

Optional filter to retrieve stats for a specific interface by name. If not provided, returns stats for all interfaces.

string

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

string
enum

Response format. If set to 'csv', returns data as a downloadable CSV file. Otherwise returns JSON.

Allowed:
Body Params

List of appliance network element primary keys (nePks) to retrieve statistics for.

Request body containing list of appliance identifiers.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized. Authentication credentials are missing or invalid.

403

Forbidden. User lacks required READ or READ_WRITE permissions.

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
application/vnd.ms-excel

Updated about 11 hours ago

Did this page help you?