HomeGuidesAPI Reference
API Reference

Get MOS time series statistics for tunnel quality monitoring

Retrieves Mean Opinion Score (MOS) time series statistics for a specific tunnel on an appliance. MOS is a measure of voice quality on a scale of 1-5, with 5 being excellent. The response includes both standard MOS values and MOS with Forward Error Correction (FEC) applied. If tunnelAlias is provided, it takes precedence over the tunnel parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

int64
required
≥ 0

Unix epoch time in seconds for the start of the time range. Must be >= 0 and less than endTime.

int64
required
≥ 0

Unix epoch time in seconds for the end of the time range. Must be >= 0 and greater than startTime.

string
enum
required

Data aggregation interval determining which statistics table to query from.

Allowed:
string
required
deprecated

Tunnel identifier (e.g., 'bondedTunnel_33'). Maps to tunnelid in database. Deprecated: use tunnelAlias instead.

string

Tunnel alias name (e.g., 'to_xxx-ecva_DefaultOverlay'). Maps to tunnelname in database. Preferred over tunnel parameter.

integer
1 to 10000
Defaults to 10000

Maximum number of records to return. Default and maximum value is 10000.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json