Get aggregated tunnel availability statistics for third-party services

get

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

Retrieves aggregated tunnel availability statistics for third-party services. Returns metrics including total downtime (tunnel_state), blackout periods, brownout periods, and IPSLA violations during business hours. Data is grouped by tunnel name, tunnel ID, tunnel type, label, and service name.

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

date

string

required

^\d{4}-\d{2}-\d{2}$

Date for statistics retrieval in YYYY-MM-DD format. For 'month' granularity, use the first day of the month (e.g., 2024-01-01).

overlayId

string

Filter by overlay ID. Use '0' for physical tunnels, 'all' or '-1' for all bonded tunnels, or a specific overlay ID number.

tunType

integer

enum

required

Tunnel type filter. Use 3 for third-party service tunnels. Valid values: 0 (SD-WAN), 1 (Underlay), 2 (Breakout/Pass-through), 3 (Services).

Allowed:

granularity

string

enum

required

Time granularity for data aggregation. Determines which database table is queried and how data is grouped.

Allowed:

serviceName

string

Filter by service provider name. Performs prefix matching (LIKE 'serviceName%'). Optional parameter for filtering results.

Responses

Language

Loading…

Response

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

application/json

200Successful response with array of tunnel availability statistics for third-party services.

400Bad Request - Invalid or non-existent appliance nePk provided.

503Service Unavailable - Unable to connect to the statistics database (ClickHouse).