Get Edge Link Metrics
DescriptionEdge WAN link transport metrics
Request
URLURL
Path Parameters
Path Parameters
The logicalId GUID for the target enterprise
The logicalId GUID for the target edge
Query Parameters
Query Parameters
Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
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
sortBy query param to sort the resultset. Format of sortBy is
Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.
Response
Response BodyResponse Body
200 OK
array of
EdgeLinkStatsRecord
of type application/json
Request successfully processed
{
"autoDualMode": "string",
"bestJitterMsRx": 0,
"bestJitterMsTx": 0,
"bestLatencyMsRx": 0,
"bestLatencyMsTx": 0,
"bestLossPctRx": 0,
"bestLossPctTx": 0,
"bpsOfBestPathRx": 0,
"bpsOfBestPathTx": 0,
"bytesRx": 0,
"bytesTx": 0,
"controlBytesRx": 0,
"controlBytesTx": 0,
"controlPacketsRx": 0,
"controlPacketsTx": 0,
"link": {
"_href": "string",
"alertsEnabled": false,
"backupState": "UNCONFIGURED",
"created": "string",
"displayName": "string",
"edge": {
"_href": "string",
"activationKey": "string",
"activationKeyExpires": "string",
"activationState": "UNASSIGNED",
"activationTime": "string",
"alertsEnabled": false,
"bastionState": "UNCONFIGURED",
"buildNumber": "string",
"created": "string",
"customInfo": "string",
"description": "string",
"deviceFamily": "string",
"deviceId": "string",
"dnsName": "string",
"edgeState": "NEVER_ACTIVATED",
"edgeStateTime": "string",
"endpointPkiMode": "CERTIFICATE_DISABLED",
"enterprise": {
"_href": "string",
"accountNumber": "string",
"alertsEnabled": false,
"bastionState": "UNCONFIGURED",
"city": "string",
"contactEmail": "string",
"contactMobile": "string",
"contactName": "string",
"contactPhone": "string",
"country": "string",
"created": "string",
"description": "string",
"domain": "string",
"endpointPkiMode": "CERTIFICATE_DISABLED",
"gatewayPool": {
"_href": "string"
},
"lat": 0,
"locale": "string",
"logicalId": "string",
"lon": 0,
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"postalCode": "string",
"prefix": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"timezone": "string"
},
"factoryBuildNumber": "string",
"factorySoftwareVersion": "string",
"haLastContact": "string",
"haMode": "string",
"haPreviousState": "UNCONFIGURED",
"haSerialNumber": "string",
"haState": "UNCONFIGURED",
"isLive": false,
"lastContact": "string",
"links": [
{
"_href": "string"
}
],
"logicalId": "string",
"lteRegion": "string",
"modelNumber": "string",
"modemBuildNumber": "string",
"modemFirmwareVersion": "string",
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"platformBuildNumber": "string",
"platformFirmwareVersion": "string",
"selfMacAddress": "string",
"serialNumber": "string",
"serviceState": "IN_SERVICE",
"serviceUpSince": "string",
"site": {
"_href": "string",
"city": "string",
"contactEmail": "string",
"contactMobile": "string",
"contactName": "string",
"contactPhone": "string",
"country": "string",
"created": "string",
"lat": 0,
"locale": "string",
"lon": 0,
"modified": "string",
"name": "string",
"postalCode": "string",
"shippingAddress": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingContactName": "string",
"shippingCountry": "string",
"shippingPostalCode": "string",
"shippingSameAsLocation": false,
"shippingState": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"timezone": "string"
},
"softwareUpdated": "string",
"softwareVersion": "string",
"standbyBuildNumber": "string",
"standbyDeviceId": "string",
"standbyFactoryBuildNumber": "string",
"standbyFactorySoftwareVersion": "string",
"standbyModelNumber": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbySystemUpSince": "string",
"systemUpSince": "string"
},
"interface": "string",
"internalId": "string",
"ipAddress": "string",
"ipV6Address": "string",
"isp": "string",
"lastActive": "string",
"lastEvent": "string",
"lastEventState": "UNKNOWN",
"lat": 0,
"linkMode": "ACTIVE",
"logicalId": "string",
"lon": 0,
"macAddress": "string",
"modified": "string",
"netmask": "string",
"networkSide": "UNKOWN",
"networkType": "UNKNOWN",
"operatorAlertsEnabled": false,
"org": "string",
"serviceState": "IN_SERVICE",
"state": "UNKNOWN",
"userOverride": false
},
"name": "string",
"p1BytesRx": 0,
"p1BytesTx": 0,
"p1PacketsRx": 0,
"p1PacketsTx": 0,
"p2BytesRx": 0,
"p2BytesTx": 0,
"p2PacketsRx": 0,
"p2PacketsTx": 0,
"p3BytesRx": 0,
"p3BytesTx": 0,
"p3PacketsRx": 0,
"p3PacketsTx": 0,
"packetsRx": 0,
"packetsTx": 0,
"scoreRx": 0,
"scoreTx": 0,
"signalStrength": 0,
"totalBytes": 0,
"totalPackets": 0
}
Errors
ValidationError
Unauthorized
Resource not found
Rate Limit Exceeded
Internal server error
