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

Get aggregated tunnel statistics for multiple appliances

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

Retrieves aggregated tunnel statistics for multiple appliances specified in the request body. Use this endpoint when querying stats for more than one appliance. Supports filtering by overlay type, sorting by metric, and CSV export.

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

Start of time range as Unix epoch timestamp in milliseconds. Must be >= 0 and < endTime.

int64
required
≥ 0

End of time range as Unix epoch timestamp in milliseconds. Must be > startTime.

string
enum
required

Time granularity for aggregation. Valid values: minute, hour, day, month. Case-insensitive.

Allowed:
boolean
Defaults to false

When true, uses IP address as grouping key instead of nePk. Default: false.

string
enum

Metric for sorting and filtering top results. Required if 'top' is specified. Must be non-empty when provided.

integer
≥ 1

Limit results to top N entries sorted by metric. Requires 'metric' parameter. Must be >= 1.

string

Filter by overlay type. 'all' = bonded tunnels, '0' = physical tunnels, specific ID = tunnels for that overlay. Omit to include all.

string
enum

Response format. Set to 'csv' for downloadable CSV file (Content-Type: application/vnd.ms-excel).

Allowed:
boolean
Defaults to true

When true, groups results by appliance in nested structure. When false, returns flat list. Default: true.

Body Params

JSON object containing the list of appliance identifiers (nePks) to retrieve statistics for.

Request body containing the 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

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?