Link Quality Event Get Link Quality Events

Link Quality Event Get Link Quality Events

Fetch per-link and overall Quality of Experience scores for the specified Edge over the specified time interval. For each link, this method reports an aggregate totalScore, a score breakdown by traffic type, a timeseries composed of samples for which pre- and post-enhancement link states are recorded by traffic type, and quality state distributions by traffic type. It also summarizes effective overall link quality scores across all links in the same format on the overallLinkQuality property.

QoE scores are computed based on a sample of events stored on the Orchestrator. Clients may optionally parameterize the number of events sampled (see the maxSamples parameter) or the duration of samples (see minutesPerSample), but the default parameter values should be sufficient for most, if not all, use cases.

The response schema for this method is unique in that several of the constituent objects use integer keys that inform how values should be interpreted.

Where breakdowns are presented by traffic type, as they are in the distribution and score summary objects, they should be interpreted as follows:

  • 0: Voice
  • 1: Video
  • 2: Transactional

Where breakdowns are presented by state, as they are in the traffic-type-specific distribution summaries, they should be interpreted as follows:

  • 0: Offline
  • 1: Unknown
  • 2: Red
  • 3: Yellow
  • 4: Green

Where actions are referenced in timeseries samples, they should be interpreted as follows:

  • 0: None
  • 1: Avoid
  • 2: Jitter Buffer
  • 3: Error Correction
  • 4: Forward Error Correction

Where metrics are referenced in timeseries samples, they should be interpreted as follows:

  • 0: Latency Rx
  • 1: Latency Tx
  • 2: Jitter Rx
  • 3: Jitter Tx
  • 4: Loss Rx
  • 5: Loss Tx

Privileges required:

READ EDGE

Request
URI
POST
https://{api_host}/portal/rest/linkQualityEvent/getLinkQualityEvents
COPY
Request Body

Show optional properties

{
    "edgeId": 512,
    "interval": {
        "start": 1609459200000,
        "end": 1609459920000
    }
}
{
    "enterpriseId": 0,
    "edgeId": 0,
    "interval": {
        "end": "string",
        "start": "string"
    },
    "maxSamples": 0,
    "minutesPerSample": 0,
    "individualScores": false,
    "links": [
        0
    ]
}
integer
enterpriseId
Optional

enterpriseId

integer
edgeId
Required

edgeId

interval
interval
Required

interval

integer
maxSamples
Optional
Constraints: default: 50

Maximum number of link quality events sampled to produce the time series used in computing scores. This may not be specified in conjunction with minutesPerSample.

integer
minutesPerSample
Optional

Duration in minutes of the interval partitions from which link quality events are samples to produce the time series used in computing scores. This may not be specified in conjunction with maxSamples.

boolean
individualScores
Optional

When true, each sample in the resulting time series is populated with its own aggregate score values (grouped by traffic type) and link quality state distribution.

array of integer
links
Optional

links

Responses
200

Request was successfully processed

Returns link_quality_event_get_link_quality_events_result of type(s) application/json 
"link_quality_event_get_link_quality_events_result Object"
object
overallLinkQuality
Optional

overallLinkQuality


400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"edgeId:"integer","interval:"object"}' https://{api_host}/portal/rest/linkQualityEvent/getLinkQualityEvents
On This Page
Link Quality Event Operations
POST
Link Quality Event Get Link Quality Events