Get aggregated MOS statistics for a single appliance

get

http://127.0.0.1:8080/stats/aggregate/mos

Retrieves aggregated MOS statistics for a single appliance. Supports filtering by tunnel name and overlay type. Use format=csv to download results as CSV 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

Unix timestamp (seconds since epoch) for data range start. Must be >= 0 and less than endTime.

endTime

int64

required

≥ 0

Unix timestamp (seconds since epoch) for data range end. Must be >= 0 and greater than startTime.

granularity

string

enum

required

Time interval for data aggregation. Determines statistical granularity.

Allowed:

tunnelName

string

Filter by tunnel name. Returns stats for a specific tunnel only.

top

integer

≥ 1

Limit results to top N tunnels by MOS value.

overlay

string

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

format

string

enum

Response format. Set to 'csv' for CSV file download, omit for JSON response.

Allowed:

groupByNE

boolean

Defaults to true

Group statistics by appliance. Adds nesting level by appliance in response.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized - Authentication required

403

Forbidden - Requires READ or READ_WRITE permission

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

200Aggregated MOS statistics for the specified appliance and time range

400Bad Request - Invalid or missing parameters