HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. aggregateStats

Get aggregate Mean Opinion Score (MOS) statistics

post
http://127.0.0.1:8080/stats2/aggregate/mos

Retrieves aggregated MOS statistics for specified appliance tunnels. Returns both post-FEC (Forward Error Correction) and pre-FEC MOS values along with timestamps for minimum values. Response format varies based on groupByNE parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
required
≥ 0

Start of the time range as Unix epoch timestamp in seconds. Must be >= 0 and less than endTime.

int64
required
≥ 0

End of the time range as Unix epoch timestamp in seconds. Must be greater than startTime.

string
enum
required

Time granularity for data aggregation. Determines the rollup interval for statistics.

Allowed:
integer
≥ 1

Limits results to the top N items based on MOS ranking. When not provided, returns all matching records.

string

Filters tunnels by overlay. Use '0' for physical tunnels only, omit for all tunnels (bonded and physical), or provide overlay ID for bonded tunnels of that overlay.

boolean
Defaults to true

Groups results by network element (appliance). Default is true, adding an extra level of nesting by appliance nePk in the response.

Body Params

Array of appliance tunnel objects specifying which tunnels to retrieve MOS statistics for.

Array of appliance-tunnel filter objects. Each entry specifies an appliance and optionally a tunnel to retrieve statistics for.

Identifies an appliance and optionally a specific tunnel for statistics retrieval.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE'.

string | null

Specific tunnel identifier to filter. If null or not provided, returns stats for all tunnels on the appliance (excluding 'all traffic' and 'optimized traffic').

string | null

Orchestrator tunnel ID. Required when isRemote is true to identify the remote tunnel.

boolean
Defaults to false

Indicates if querying for a remote tunnel. When true, orchTid must be provided. Stats are retrieved from peer appliances.

Responses

Updated about 14 hours ago

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

Updated about 14 hours ago

Did this page help you?