Get aggregate jitter stats for single appliance or group

get

http://127.0.0.1:8080/stats/aggregate/jitter

Retrieves aggregate jitter statistics for a single appliance (via nePk), appliance group (via groupPk), or all appliances. When nePk is provided, validates the appliance exists.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

tunnelName

string

Filter results by specific tunnel name. Returns jitter stats only for the specified tunnel.

groupPk

string

Internal group ID to filter statistics for a specific appliance group. Used when nePk is not provided.

startTime

int64

required

≥ 0

Unix timestamp (seconds since epoch) for the start of the data time range. Must be non-negative and less than endTime.

endTime

int64

required

≥ 0

Unix timestamp (seconds since epoch) for the end of the data time range. Must be greater than startTime.

granularity

string

enum

required

Data aggregation interval. Determines how stats are grouped temporally.

Allowed:

boolean

Defaults to false

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

top

integer

≥ 1

Maximum number of results to return. When nePk is empty, requires metric parameter.

overlay

string

Filter tunnels by overlay type. Use 'all' for bonded tunnels, '0' for physical tunnels only, or specific overlay ID.

groupByNE

boolean

Defaults to true

When true, groups results by appliance with nested stats objects. Default is true.

format

string

enum

Response format. Use 'csv' to download results as CSV file. Omit for JSON response.

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 retrieval of aggregate jitter statistics.

400Bad request due to invalid or missing parameters.