Get interface overlay transport time series stats data of a single appliance filter by certain query parameters.

get

http://127.0.0.1:8080/stats/timeseries/interfaceOverlay

This operation returns a JSON object containing data objects of each interface overlay transport is an array, each data object contains the stats for a particular timestamp.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

required

Internal ID of the appliance to filter from

startTime

integer

required

Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range

endTime

integer

required

Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range

granularity

string

enum

required

Data granularity filtering whether data is minutely data, hourly data or daily data.

Allowed:

overlay

string

When it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.

tunnelType

integer

enum

Possible Tunnel type values for overlays are : 0 – SD-WAN, 2 – Breakout, 3 – Services. And Possible Tunnel type values for underlays are: 1 - Underlay, 2 – Pass through, 3 – Services.

Allowed:

labelId

integer

Label internal id

isWanSide

boolean

Get WAN side data (true) or LAN side data (false)

interfaceName

string

Interface name

limit

integer

Limit the number of stats entity retrieved. Default and maximum limits are both 10000.

Response

Language

Loading…

Response

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

application/json

200No response was specified