Get aggregated tunnel statistics

get

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

Retrieves aggregated tunnel statistics for a single appliance or group of appliances. Results can be filtered by tunnel name, overlay type, and time range. Supports sorting by various metrics and limiting results with the 'top' parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

startTime

int64

required

≥ 0

Starting time boundary as Unix epoch timestamp in milliseconds. Must be non-negative and less than endTime.

endTime

int64

required

≥ 0

Ending time boundary as Unix epoch timestamp in milliseconds. Must be greater than startTime.

granularity

string

enum

required

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

Allowed:

groupPk

string

Internal group ID to filter stats for appliances within that group. Only used when nePk is not provided.

tunnelName

string

Filter results to a specific tunnel by name.

boolean

Defaults to false

When true, uses IP address as the grouping key instead of internal appliance ID (nePk).

metric

string

enum

Metric to sort results by. Required when using 'top' parameter.

top

integer

≥ 1

Number of top results to return when sorting by metric. Requires 'metric' parameter to be specified.

overlay

string

Filter tunnels by overlay type. 'all' returns bonded tunnels; '0' returns physical tunnels; specific ID returns tunnels for that overlay; omit to return all tunnels.

format

string

enum

Output format. Use 'csv' for CSV file download.

Allowed:

groupByNE

boolean

Defaults to true

When true, groups stats by appliance with nested structure. When false, returns flat stats.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.ms-excel

200Successfully retrieved tunnel aggregate statistics

400Bad Request - Invalid parameters