Get tunnel time series stats for a single appliance

get

http://127.0.0.1:8080/stats/timeseries/tunnel

Retrieves tunnel-level time series statistics for a single appliance. Returns a JSON object with COLUMN_DEF (array of metric names) and DATA (keyed by appliance ID, containing arrays of metric values per timestamp). Each data array entry corresponds to metrics defined in COLUMN_DEF. Supports CSV export for reporting purposes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

required

^\d+\.NE$

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

startTime

int64

required

≥ 0

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

endTime

int64

required

≥ 0

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

granularity

string

enum

required

Data aggregation interval determining time resolution. 'minute' for minutely data, 'hour' for hourly aggregates, 'day' for daily aggregates.

Allowed:

tunnelName

string

required

Internal tunnel identifier (maps to tunnelId in database). Example: 'bondedTunnel_5'. This parameter is being deprecated; use tunnelAlias instead when possible.

tunnelAlias

string

Human-readable tunnel name/alias (maps to tunnelName in database). Example: 'to_ecva_DefaultOverlay'. Preferred over tunnelName parameter.

limit

integer

1 to 10000

Defaults to 10000

Maximum number of data points to return. Default and maximum value is 10000.

format

string

enum

Response format. When set to 'CSV', returns data as a downloadable CSV file instead of JSON.

Allowed:

boolean

Defaults to false

When true, uses IP address as the grouping key instead of internal appliance ID. Default is false.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ or READ_WRITE permission

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

200Successful response with tunnel time series statistics

400Bad Request - Invalid or missing required parameters