Get internet breakout time series statistics for an appliance.

get

http://127.0.0.1:8080/stats/timeseries/internetBreakout

Retrieves internet breakout performance statistics over time for a specified appliance. Returns metrics including average latency, packet loss, jitter, MOS scores, and configured thresholds. Data can be filtered by overlay name and interface, with configurable time granularity. Supports both JSON response and CSV file download.

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').

overlayName

string

Name of the overlay network to filter results. When omitted, returns data for all overlays.

ifName

string

Network interface name to filter results. When omitted, returns data for all interfaces.

startTime

int64

required

≥ 0

Start of the time range in Unix epoch seconds (signed 64-bit). Must be non-negative and less than endTime.

endTime

int64

required

≥ 0

End of the time range in Unix epoch seconds (signed 64-bit). Must be non-negative and greater than startTime.

granularity

string

enum

required

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

Allowed:

limit

int32

≥ 1

Maximum number of data rows to return. Useful for limiting response size when querying large time ranges.

format

string

enum

Response format type. Set to 'csv' to download data as CSV file, otherwise returns JSON.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized. User lacks READ or READ_WRITE role permissions.

403

Forbidden. Access denied to the requested appliance.

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 retrieval of internet breakout time series statistics.

400Bad request due to invalid or missing parameters.