Get tunnel time series statistics for a single appliance

get

http://127.0.0.1:8080/stats3/timeseries/tunnel

Retrieves tunnel time series statistics for a single appliance filtered by query parameters. Returns a JSON object with 'column_def' (array of column names) and 'data' (array of stats arrays). Column definitions and data structure vary based on the selected metric. When format=CSV, returns a downloadable Excel-compatible file.

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 time boundary as Unix epoch seconds (signed 64-bit). Must be >= 0 and less than endTime.

endTime

int64

required

≥ 0

End time boundary as Unix epoch seconds (signed 64-bit). Must be >= 0 and greater than startTime.

granularity

string

enum

required

Data aggregation interval. Determines which database table is queried (minute, hourly, or daily).

Allowed:

tunnelAlias

string

required

Tunnel name/alias to filter statistics. Cannot be empty.

limit

integer

1 to 10000

Defaults to 10000

Maximum number of stats records to retrieve. Default: 10000, Maximum: 10000.

format

string

enum

Response format. Use 'CSV' for downloadable Excel-compatible file. Default: JSON.

Allowed:

boolean

Defaults to false

Use IP address as key for grouping stats instead of nePk. Default: false.

overlay

string

Overlay filter for bonded tunnels. Required when metric is 'throughput'. Values: '0' returns physical tunnels only; omitted returns all tunnels; other values return bonded tunnels for that overlay ID.

metric

string

enum

required

Metric type determining which statistics columns are returned. Each metric returns different column definitions.

Allowed:

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

200Successful response with column definitions and time series data arrays.

400Bad Request - Validation error