Get Enterprise Link Metrics

Get Enterprise Link Metrics

Fetch aggregate WAN link transport metrics for all Customer links

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

The logicalId GUID for the target enterprise

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.

string
metrics
Required

metrics supported for querying linkStats

Possible values are : bytesTx, bytesRx, packetsTx, packetsRx, totalBytes, totalPackets, p1BytesRx, p1BytesTx, p1PacketsRx, p1PacketsTx, p2BytesRx, p2BytesTx, p2PacketsRx, p2PacketsTx, p3BytesRx, p3BytesTx, p3PacketsRx, p3PacketsTx, controlBytesRx, controlBytesTx, controlPacketsRx, controlPacketsTx, bpsOfBestPathRx, bpsOfBestPathTx, bestJitterMsRx, bestJitterMsTx, bestLatencyMsRx, bestLatencyMsTx, bestLossPctRx, bestLossPctTx, scoreTx, scoreRx, signalStrength, state, autoDualMode,
integer
start
Optional

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.

number
bytesTx[is]
Optional

Filter by bytesTx[is]

number
bytesTx[isNot]
Optional

Filter by bytesTx[isNot]

number
bytesTx[greaterOrEquals]
Optional

Filter by bytesTx[greaterOrEquals]

number
bytesTx[lesserOrEquals]
Optional

Filter by bytesTx[lesserOrEquals]

number
bytesRx[is]
Optional

Filter by bytesRx[is]

number
bytesRx[isNot]
Optional

Filter by bytesRx[isNot]

number
bytesRx[greaterOrEquals]
Optional

Filter by bytesRx[greaterOrEquals]

number
bytesRx[lesserOrEquals]
Optional

Filter by bytesRx[lesserOrEquals]

number
packetsTx[is]
Optional

Filter by packetsTx[is]

number
packetsTx[isNot]
Optional

Filter by packetsTx[isNot]

number
packetsTx[greaterOrEquals]
Optional

Filter by packetsTx[greaterOrEquals]

number
packetsTx[lesserOrEquals]
Optional

Filter by packetsTx[lesserOrEquals]

number
packetsRx[is]
Optional

Filter by packetsRx[is]

number
packetsRx[isNot]
Optional

Filter by packetsRx[isNot]

number
packetsRx[greaterOrEquals]
Optional

Filter by packetsRx[greaterOrEquals]

number
packetsRx[lesserOrEquals]
Optional

Filter by packetsRx[lesserOrEquals]

number
totalBytes[is]
Optional

Filter by totalBytes[is]

number
totalBytes[isNot]
Optional

Filter by totalBytes[isNot]

number
totalBytes[greaterOrEquals]
Optional

Filter by totalBytes[greaterOrEquals]

number
totalBytes[lesserOrEquals]
Optional

Filter by totalBytes[lesserOrEquals]

number
totalPackets[is]
Optional

Filter by totalPackets[is]

number
totalPackets[isNot]
Optional

Filter by totalPackets[isNot]

number
totalPackets[greaterOrEquals]
Optional

Filter by totalPackets[greaterOrEquals]

number
totalPackets[lesserOrEquals]
Optional

Filter by totalPackets[lesserOrEquals]

number
p1BytesRx[is]
Optional

Filter by p1BytesRx[is]

number
p1BytesRx[isNot]
Optional

Filter by p1BytesRx[isNot]

number
p1BytesRx[greaterOrEquals]
Optional

Filter by p1BytesRx[greaterOrEquals]

number
p1BytesRx[lesserOrEquals]
Optional

Filter by p1BytesRx[lesserOrEquals]

number
p1BytesTx[is]
Optional

Filter by p1BytesTx[is]

number
p1BytesTx[isNot]
Optional

Filter by p1BytesTx[isNot]

number
p1BytesTx[greaterOrEquals]
Optional

Filter by p1BytesTx[greaterOrEquals]

number
p1BytesTx[lesserOrEquals]
Optional

Filter by p1BytesTx[lesserOrEquals]

number
p1PacketsRx[is]
Optional

Filter by p1PacketsRx[is]

number
p1PacketsRx[isNot]
Optional

Filter by p1PacketsRx[isNot]

number
p1PacketsRx[greaterOrEquals]
Optional

Filter by p1PacketsRx[greaterOrEquals]

number
p1PacketsRx[lesserOrEquals]
Optional

Filter by p1PacketsRx[lesserOrEquals]

number
p1PacketsTx[is]
Optional

Filter by p1PacketsTx[is]

number
p1PacketsTx[isNot]
Optional

Filter by p1PacketsTx[isNot]

number
p1PacketsTx[greaterOrEquals]
Optional

Filter by p1PacketsTx[greaterOrEquals]

number
p1PacketsTx[lesserOrEquals]
Optional

Filter by p1PacketsTx[lesserOrEquals]

number
p2BytesRx[is]
Optional

Filter by p2BytesRx[is]

number
p2BytesRx[isNot]
Optional

Filter by p2BytesRx[isNot]

number
p2BytesRx[greaterOrEquals]
Optional

Filter by p2BytesRx[greaterOrEquals]

number
p2BytesRx[lesserOrEquals]
Optional

Filter by p2BytesRx[lesserOrEquals]

number
p2BytesTx[is]
Optional

Filter by p2BytesTx[is]

number
p2BytesTx[isNot]
Optional

Filter by p2BytesTx[isNot]

number
p2BytesTx[greaterOrEquals]
Optional

Filter by p2BytesTx[greaterOrEquals]

number
p2BytesTx[lesserOrEquals]
Optional

Filter by p2BytesTx[lesserOrEquals]

number
p2PacketsRx[is]
Optional

Filter by p2PacketsRx[is]

number
p2PacketsRx[isNot]
Optional

Filter by p2PacketsRx[isNot]

number
p2PacketsRx[greaterOrEquals]
Optional

Filter by p2PacketsRx[greaterOrEquals]

number
p2PacketsRx[lesserOrEquals]
Optional

Filter by p2PacketsRx[lesserOrEquals]

number
p2PacketsTx[is]
Optional

Filter by p2PacketsTx[is]

number
p2PacketsTx[isNot]
Optional

Filter by p2PacketsTx[isNot]

number
p2PacketsTx[greaterOrEquals]
Optional

Filter by p2PacketsTx[greaterOrEquals]

number
p2PacketsTx[lesserOrEquals]
Optional

Filter by p2PacketsTx[lesserOrEquals]

number
p3BytesRx[is]
Optional

Filter by p3BytesRx[is]

number
p3BytesRx[isNot]
Optional

Filter by p3BytesRx[isNot]

number
p3BytesRx[greaterOrEquals]
Optional

Filter by p3BytesRx[greaterOrEquals]

number
p3BytesRx[lesserOrEquals]
Optional

Filter by p3BytesRx[lesserOrEquals]

number
p3BytesTx[is]
Optional

Filter by p3BytesTx[is]

number
p3BytesTx[isNot]
Optional

Filter by p3BytesTx[isNot]

number
p3BytesTx[greaterOrEquals]
Optional

Filter by p3BytesTx[greaterOrEquals]

number
p3BytesTx[lesserOrEquals]
Optional

Filter by p3BytesTx[lesserOrEquals]

number
p3PacketsRx[is]
Optional

Filter by p3PacketsRx[is]

number
p3PacketsRx[isNot]
Optional

Filter by p3PacketsRx[isNot]

number
p3PacketsRx[greaterOrEquals]
Optional

Filter by p3PacketsRx[greaterOrEquals]

number
p3PacketsRx[lesserOrEquals]
Optional

Filter by p3PacketsRx[lesserOrEquals]

number
p3PacketsTx[is]
Optional

Filter by p3PacketsTx[is]

number
p3PacketsTx[isNot]
Optional

Filter by p3PacketsTx[isNot]

number
p3PacketsTx[greaterOrEquals]
Optional

Filter by p3PacketsTx[greaterOrEquals]

number
p3PacketsTx[lesserOrEquals]
Optional

Filter by p3PacketsTx[lesserOrEquals]

number
controlBytesRx[is]
Optional

Filter by controlBytesRx[is]

number
controlBytesRx[isNot]
Optional

Filter by controlBytesRx[isNot]

number
controlBytesRx[greaterOrEquals]
Optional

Filter by controlBytesRx[greaterOrEquals]

number
controlBytesRx[lesserOrEquals]
Optional

Filter by controlBytesRx[lesserOrEquals]

number
controlBytesTx[is]
Optional

Filter by controlBytesTx[is]

number
controlBytesTx[isNot]
Optional

Filter by controlBytesTx[isNot]

number
controlBytesTx[greaterOrEquals]
Optional

Filter by controlBytesTx[greaterOrEquals]

number
controlBytesTx[lesserOrEquals]
Optional

Filter by controlBytesTx[lesserOrEquals]

number
controlPacketsRx[is]
Optional

Filter by controlPacketsRx[is]

number
controlPacketsRx[isNot]
Optional

Filter by controlPacketsRx[isNot]

number
controlPacketsRx[greaterOrEquals]
Optional

Filter by controlPacketsRx[greaterOrEquals]

number
controlPacketsRx[lesserOrEquals]
Optional

Filter by controlPacketsRx[lesserOrEquals]

number
controlPacketsTx[is]
Optional

Filter by controlPacketsTx[is]

number
controlPacketsTx[isNot]
Optional

Filter by controlPacketsTx[isNot]

number
controlPacketsTx[greaterOrEquals]
Optional

Filter by controlPacketsTx[greaterOrEquals]

number
controlPacketsTx[lesserOrEquals]
Optional

Filter by controlPacketsTx[lesserOrEquals]

number
bpsOfBestPathRx[is]
Optional

Filter by bpsOfBestPathRx[is]

number
bpsOfBestPathRx[isNot]
Optional

Filter by bpsOfBestPathRx[isNot]

number
bpsOfBestPathRx[greaterOrEquals]
Optional

Filter by bpsOfBestPathRx[greaterOrEquals]

number
bpsOfBestPathRx[lesserOrEquals]
Optional

Filter by bpsOfBestPathRx[lesserOrEquals]

number
bpsOfBestPathTx[is]
Optional

Filter by bpsOfBestPathTx[is]

number
bpsOfBestPathTx[isNot]
Optional

Filter by bpsOfBestPathTx[isNot]

number
bpsOfBestPathTx[greaterOrEquals]
Optional

Filter by bpsOfBestPathTx[greaterOrEquals]

number
bpsOfBestPathTx[lesserOrEquals]
Optional

Filter by bpsOfBestPathTx[lesserOrEquals]

number
bestJitterMsRx[is]
Optional

Filter by bestJitterMsRx[is]

number
bestJitterMsRx[isNot]
Optional

Filter by bestJitterMsRx[isNot]

number
bestJitterMsRx[greaterOrEquals]
Optional

Filter by bestJitterMsRx[greaterOrEquals]

number
bestJitterMsRx[lesserOrEquals]
Optional

Filter by bestJitterMsRx[lesserOrEquals]

number
bestJitterMsTx[is]
Optional

Filter by bestJitterMsTx[is]

number
bestJitterMsTx[isNot]
Optional

Filter by bestJitterMsTx[isNot]

number
bestJitterMsTx[greaterOrEquals]
Optional

Filter by bestJitterMsTx[greaterOrEquals]

number
bestJitterMsTx[lesserOrEquals]
Optional

Filter by bestJitterMsTx[lesserOrEquals]

number
bestLatencyMsRx[is]
Optional

Filter by bestLatencyMsRx[is]

number
bestLatencyMsRx[isNot]
Optional

Filter by bestLatencyMsRx[isNot]

number
bestLatencyMsRx[greaterOrEquals]
Optional

Filter by bestLatencyMsRx[greaterOrEquals]

number
bestLatencyMsRx[lesserOrEquals]
Optional

Filter by bestLatencyMsRx[lesserOrEquals]

number
bestLatencyMsTx[is]
Optional

Filter by bestLatencyMsTx[is]

number
bestLatencyMsTx[isNot]
Optional

Filter by bestLatencyMsTx[isNot]

number
bestLatencyMsTx[greaterOrEquals]
Optional

Filter by bestLatencyMsTx[greaterOrEquals]

number
bestLatencyMsTx[lesserOrEquals]
Optional

Filter by bestLatencyMsTx[lesserOrEquals]

number
bestLossPctRx[is]
Optional

Filter by bestLossPctRx[is]

number
bestLossPctRx[isNot]
Optional

Filter by bestLossPctRx[isNot]

number
bestLossPctRx[greaterOrEquals]
Optional

Filter by bestLossPctRx[greaterOrEquals]

number
bestLossPctRx[lesserOrEquals]
Optional

Filter by bestLossPctRx[lesserOrEquals]

number
bestLossPctTx[is]
Optional

Filter by bestLossPctTx[is]

number
bestLossPctTx[isNot]
Optional

Filter by bestLossPctTx[isNot]

number
bestLossPctTx[greaterOrEquals]
Optional

Filter by bestLossPctTx[greaterOrEquals]

number
bestLossPctTx[lesserOrEquals]
Optional

Filter by bestLossPctTx[lesserOrEquals]

number
scoreTx[is]
Optional

Filter by scoreTx[is]

number
scoreTx[isNot]
Optional

Filter by scoreTx[isNot]

number
scoreTx[greaterOrEquals]
Optional

Filter by scoreTx[greaterOrEquals]

number
scoreTx[lesserOrEquals]
Optional

Filter by scoreTx[lesserOrEquals]

number
scoreRx[is]
Optional

Filter by scoreRx[is]

number
scoreRx[isNot]
Optional

Filter by scoreRx[isNot]

number
scoreRx[greaterOrEquals]
Optional

Filter by scoreRx[greaterOrEquals]

number
scoreRx[lesserOrEquals]
Optional

Filter by scoreRx[lesserOrEquals]

number
signalStrength[is]
Optional

Filter by signalStrength[is]

number
signalStrength[isNot]
Optional

Filter by signalStrength[isNot]

number
signalStrength[greaterOrEquals]
Optional

Filter by signalStrength[greaterOrEquals]

number
signalStrength[lesserOrEquals]
Optional

Filter by signalStrength[lesserOrEquals]

number
autoDualMode[is]
Optional

Filter by autoDualMode[is]

number
autoDualMode[isNot]
Optional

Filter by autoDualMode[isNot]

number
autoDualMode[greaterOrEquals]
Optional

Filter by autoDualMode[greaterOrEquals]

number
autoDualMode[lesserOrEquals]
Optional

Filter by autoDualMode[lesserOrEquals]

Responses
200

Request successfully processed

Returns Array of EdgeLinkStatsRecord 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"
        },
        "bytesTx": "number",
        "bytesRx": "number",
        "packetsTx": "number",
        "packetsRx": "number",
        "totalBytes": "number",
        "totalPackets": "number",
        "p1BytesRx": "number",
        "p1BytesTx": "number",
        "p1PacketsRx": "number",
        "p1PacketsTx": "number",
        "p2BytesRx": "number",
        "p2BytesTx": "number",
        "p2PacketsRx": "number",
        "p2PacketsTx": "number",
        "p3BytesRx": "number",
        "p3BytesTx": "number",
        "p3PacketsRx": "number",
        "p3PacketsTx": "number",
        "controlBytesRx": "number",
        "controlBytesTx": "number",
        "controlPacketsRx": "number",
        "controlPacketsTx": "number",
        "bpsOfBestPathRx": "number",
        "bpsOfBestPathTx": "number",
        "bestJitterMsRx": "number",
        "bestJitterMsTx": "number",
        "bestLatencyMsRx": "number",
        "bestLatencyMsTx": "number",
        "bestLossPctRx": "number",
        "bestLossPctTx": "number",
        "scoreTx": "number",
        "scoreRx": "number",
        "signalStrength": "number",
        "name": "string",
        "autoDualMode": "string"
    }
]

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

array of ValidationErrorListItem
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


On This Page
Monitor Operations
POST
Create Enterprise
DELETE
Delete Enterprise
GET
Get Enterprise
GET
Get Enterprise Aggregate Health Stats
GET
Get Enterprise Application By Id
GET
Get Enterprise Applications
GET
Get Enterprise Firewall Edge Summary Metrics
GET
Get Enterprise Flow Metrics
GET
Get Enterprise Link Metrics
GET
Get Enterprise Nni Metrics
GET
Get Enterprise Nni Series
GET
Get Enterprises