Get Edge Link Quality Events

Get Edge Link Quality Events

Fetch link quality scores for an Edge

Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/linkQualityStats
COPY
Path Parameters
string
enterpriseLogicalId
Required

The logicalId GUID for the target enterprise

string
edgeLogicalId
Required

The logicalId GUID for the target edge

Query Parameters
string
include
Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.

integer
start
Required

Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.

integer
end
Optional

Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.


Responses
200

Request successfully processed

Returns Array of LinkQualityMetricsRecord of type(s) application/json
[
    {
        "link": {
            "_href": "string",
            "created": "string",
            "edge": {
                "_href": "string",
                "activationKey": "string",
                "activationKeyExpires": "string",
                "activationState": "string",
                "activationTime": "string",
                "alertsEnabled": false,
                "bastionState": "string",
                "buildNumber": "string",
                "created": "string",
                "customInfo": "string",
                "description": "string",
                "deviceFamily": "string",
                "deviceId": "string",
                "dnsName": "string",
                "edgeState": "string",
                "edgeStateTime": "string",
                "endpointPkiMode": "string",
                "factoryBuildNumber": "string",
                "factorySoftwareVersion": "string",
                "platformBuildNumber": "string",
                "platformFirmwareVersion": "string",
                "modemBuildNumber": "string",
                "modemFirmwareVersion": "string",
                "lteRegion": "string",
                "haLastContact": "string",
                "haPreviousState": "string",
                "haSerialNumber": "string",
                "haState": "string",
                "isLive": false,
                "lastContact": "string",
                "logicalId": "string",
                "modelNumber": "string",
                "modified": "string",
                "name": "string",
                "operatorAlertsEnabled": false,
                "selfMacAddress": "string",
                "serialNumber": "string",
                "serviceState": "string",
                "serviceUpSince": "string",
                "softwareUpdated": "string",
                "softwareVersion": "string",
                "systemUpSince": "string",
                "links": [
                    {
                        "_href": "string"
                    }
                ],
                "site": {
                    "_href": "string",
                    "created": "string",
                    "name": "string",
                    "contactName": "string",
                    "contactPhone": "string",
                    "contactMobile": "string",
                    "contactEmail": "string",
                    "streetAddress": "string",
                    "streetAddress2": "string",
                    "city": "string",
                    "state": "string",
                    "country": "string",
                    "postalCode": "string",
                    "lat": "number",
                    "lon": "number",
                    "timezone": "string",
                    "locale": "string",
                    "shippingSameAsLocation": false,
                    "shippingContactName": "string",
                    "shippingAddress": "string",
                    "shippingAddress2": "string",
                    "shippingCity": "string",
                    "shippingState": "string",
                    "shippingCountry": "string",
                    "shippingPostalCode": "string",
                    "modified": "string"
                },
                "enterprise": {
                    "_href": "string",
                    "created": "string",
                    "alertsEnabled": false,
                    "operatorAlertsEnabled": false,
                    "endpointPkiMode": "string",
                    "name": "string",
                    "domain": "string",
                    "prefix": "string",
                    "logicalId": "string",
                    "accountNumber": "string",
                    "description": "string",
                    "contactName": "string",
                    "contactPhone": "string",
                    "contactMobile": "string",
                    "contactEmail": "string",
                    "streetAddress": "string",
                    "streetAddress2": "string",
                    "city": "string",
                    "state": "string",
                    "postalCode": "string",
                    "country": "string",
                    "lat": "number",
                    "lon": "number",
                    "timezone": "string",
                    "locale": "string",
                    "modified": "string",
                    "gatewayPool": {
                        "_href": "string"
                    },
                    "bastionState": "string"
                },
                "haMode": "string",
                "standbySystemUpSince": "string",
                "standbyServiceUpSince": "string",
                "standbySoftwareVersion": "string",
                "standbyFactorySoftwareVersion": "string",
                "standbyFactoryBuildNumber": "string",
                "standbyBuildNumber": "string",
                "standbyModelNumber": "string",
                "standbyDeviceId": "string"
            },
            "logicalId": "string",
            "internalId": "string",
            "interface": "string",
            "macAddress": "string",
            "ipAddress": "string",
            "ipV6Address": "string",
            "netmask": "string",
            "networkSide": "string",
            "networkType": "string",
            "displayName": "string",
            "userOverride": false,
            "isp": "string",
            "org": "string",
            "lat": "number",
            "lon": "number",
            "lastActive": "string",
            "state": "string",
            "backupState": "string",
            "linkMode": "string",
            "lastEvent": "string",
            "lastEventState": "string",
            "alertsEnabled": false,
            "operatorAlertsEnabled": false,
            "serviceState": "string",
            "modified": "string"
        },
        "scoreAfterVoice": "number",
        "scoreAfterVideo": "number",
        "scoreAfterTrans": "number",
        "scoreBeforeVoice": "number",
        "scoreBeforeVideo": "number",
        "scoreBeforeTrans": "number"
    }
]

400

ValidationError

Returns ValidationError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string",
    "errors": [
        {
            "message": "string",
            "path": "string"
        }
    ]
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation

errors
Optional

A list of property-specific errors


401

Unauthorized

Returns UnAuthorized of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


404

Resource not found

Returns ResourceNotFoundError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


429

Rate Limit Exceeded

Returns RateLimitExceededError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


500

Internal server error

Returns InternalServerError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation