Get Edge Path Metrics
DescriptionFetch path stats metrics from an edge
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.
Limits the maximum size of the result set.
metrics supported for querying pathStats
Possible values are: bytesRx , bytesTx , totalBytes , packetsRx , packetsTx , totalPackets , p1BytesRx , p1BytesTx , p1PacketsRx , p1PacketsTx , p2BytesRx , p2BytesTx , p2PacketsRx , p2PacketsTx , p3BytesRx , p3BytesTx , p3PacketsRx , p3PacketsTx , controlBytesRx , controlBytesTx , controlPacketsRx , controlPacketsTx , bpsRx , bpsRxMin , bpsRxMax , bpsTx , bpsTxMin , bpsTxMax , latencyRx , latencyRxMin , latencyRxMax , latencyTx , latencyTxMin , latencyTxMax , jitterRx , jitterRxMin , jitterRxMax , jitterTx , jitterTxMin , jitterTxMax , packetLossRx , packetLossRxMin , packetLossRxMax , packetLossTx , packetLossTxMin , packetLossTxMax , scoreBeforeVoice , scoreBeforeVideo , scoreBeforeTrans , scoreAfterVoice , scoreAfterVideo , scoreAfterTrans
The logicalId
GUID for the path stats peer
Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.
Response
Response BodyResponse Body
200 OK
array
of
EdgePathStatsMetricsResource
of type application/json
Request successfully processed
{
"destination": {},
"metrics": {
"bpsRx": 0,
"bpsRxMax": 0,
"bpsRxMin": 0,
"bpsTx": 0,
"bpsTxMax": 0,
"bpsTxMin": 0,
"bytesRx": 0,
"bytesTx": 0,
"controlBytesRx": 0,
"controlBytesTx": 0,
"controlPacketsRx": 0,
"controlPacketsTx": 0,
"jitterRx": 0,
"jitterRxMax": 0,
"jitterRxMin": 0,
"jitterTx": 0,
"jitterTxMax": 0,
"jitterTxMin": 0,
"latencyRx": 0,
"latencyRxMax": 0,
"latencyRxMin": 0,
"latencyTx": 0,
"latencyTxMax": 0,
"latencyTxMin": 0,
"p1BytesRx": 0,
"p1BytesTx": 0,
"p1PacketsRx": 0,
"p1PacketsTx": 0,
"p2BytesRx": 0,
"p2BytesTx": 0,
"p2PacketsRx": 0,
"p2PacketsTx": 0,
"p3BytesRx": 0,
"p3BytesTx": 0,
"p3PacketsRx": 0,
"p3PacketsTx": 0,
"packetLossRx": 0,
"packetLossRxMax": 0,
"packetLossRxMin": 0,
"packetLossTx": 0,
"packetLossTxMax": 0,
"packetLossTxMin": 0,
"packetsRx": 0,
"packetsTx": 0,
"scoreAfterTrans": 0,
"scoreAfterVideo": 0,
"scoreAfterVoice": 0,
"scoreBeforeTrans": 0,
"scoreBeforeVideo": 0,
"scoreBeforeVoice": 0,
"totalBytes": 0,
"totalPackets": 0
},
"source": {
"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",
"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",
"systemUpSince": "string"
},
"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",
"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",
"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
}
},
"status": "string"
}
Errors
ValidationError
Unauthorized
Resource not found
Rate Limit Exceeded
Internal server error