[{"label":"Latest (v1.0)","version":"latest"}]

vmware-sase-platform

Get Enterprise Link Metrics

Description

Fetch aggregate WAN link transport metrics for all Customer links

Request

URL

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

number

autoDualMode[greaterOrEquals] Optional

Filter by autoDualMode[greaterOrEquals]

number

autoDualMode[isNot] Optional

Filter by autoDualMode[isNot]

number

autoDualMode[is] Optional

Filter by autoDualMode[is]

number

autoDualMode[lesserOrEquals] Optional

Filter by autoDualMode[lesserOrEquals]

number

bestJitterMsRx[greaterOrEquals] Optional

Filter by bestJitterMsRx[greaterOrEquals]

number

bestJitterMsRx[isNot] Optional

Filter by bestJitterMsRx[isNot]

number

bestJitterMsRx[is] Optional

Filter by bestJitterMsRx[is]

number

bestJitterMsRx[lesserOrEquals] Optional

Filter by bestJitterMsRx[lesserOrEquals]

number

bestJitterMsTx[greaterOrEquals] Optional

Filter by bestJitterMsTx[greaterOrEquals]

number

bestJitterMsTx[isNot] Optional

Filter by bestJitterMsTx[isNot]

number

bestJitterMsTx[is] Optional

Filter by bestJitterMsTx[is]

number

bestJitterMsTx[lesserOrEquals] Optional

Filter by bestJitterMsTx[lesserOrEquals]

number

bestLatencyMsRx[greaterOrEquals] Optional

Filter by bestLatencyMsRx[greaterOrEquals]

number

bestLatencyMsRx[isNot] Optional

Filter by bestLatencyMsRx[isNot]

number

bestLatencyMsRx[is] Optional

Filter by bestLatencyMsRx[is]

number

bestLatencyMsRx[lesserOrEquals] Optional

Filter by bestLatencyMsRx[lesserOrEquals]

number

bestLatencyMsTx[greaterOrEquals] Optional

Filter by bestLatencyMsTx[greaterOrEquals]

number

bestLatencyMsTx[isNot] Optional

Filter by bestLatencyMsTx[isNot]

number

bestLatencyMsTx[is] Optional

Filter by bestLatencyMsTx[is]

number

bestLatencyMsTx[lesserOrEquals] Optional

Filter by bestLatencyMsTx[lesserOrEquals]

number

bestLossPctRx[greaterOrEquals] Optional

Filter by bestLossPctRx[greaterOrEquals]

number

bestLossPctRx[isNot] Optional

Filter by bestLossPctRx[isNot]

number

bestLossPctRx[is] Optional

Filter by bestLossPctRx[is]

number

bestLossPctRx[lesserOrEquals] Optional

Filter by bestLossPctRx[lesserOrEquals]

number

bestLossPctTx[greaterOrEquals] Optional

Filter by bestLossPctTx[greaterOrEquals]

number

bestLossPctTx[isNot] Optional

Filter by bestLossPctTx[isNot]

number

bestLossPctTx[is] Optional

Filter by bestLossPctTx[is]

number

bestLossPctTx[lesserOrEquals] Optional

Filter by bestLossPctTx[lesserOrEquals]

number

bpsOfBestPathRx[greaterOrEquals] Optional

Filter by bpsOfBestPathRx[greaterOrEquals]

number

bpsOfBestPathRx[isNot] Optional

Filter by bpsOfBestPathRx[isNot]

number

bpsOfBestPathRx[is] Optional

Filter by bpsOfBestPathRx[is]

number

bpsOfBestPathRx[lesserOrEquals] Optional

Filter by bpsOfBestPathRx[lesserOrEquals]

number

bpsOfBestPathTx[greaterOrEquals] Optional

Filter by bpsOfBestPathTx[greaterOrEquals]

number

bpsOfBestPathTx[isNot] Optional

Filter by bpsOfBestPathTx[isNot]

number

bpsOfBestPathTx[is] Optional

Filter by bpsOfBestPathTx[is]

number

bpsOfBestPathTx[lesserOrEquals] Optional

Filter by bpsOfBestPathTx[lesserOrEquals]

number

bytesRx[greaterOrEquals] Optional

Filter by bytesRx[greaterOrEquals]

number

bytesRx[isNot] Optional

Filter by bytesRx[isNot]

number

bytesRx[is] Optional

Filter by bytesRx[is]

number

bytesRx[lesserOrEquals] Optional

Filter by bytesRx[lesserOrEquals]

number

bytesTx[greaterOrEquals] Optional

Filter by bytesTx[greaterOrEquals]

number

bytesTx[isNot] Optional

Filter by bytesTx[isNot]

number

bytesTx[is] Optional

Filter by bytesTx[is]

number

bytesTx[lesserOrEquals] Optional

Filter by bytesTx[lesserOrEquals]

number

controlBytesRx[greaterOrEquals] Optional

Filter by controlBytesRx[greaterOrEquals]

number

controlBytesRx[isNot] Optional

Filter by controlBytesRx[isNot]

number

controlBytesRx[is] Optional

Filter by controlBytesRx[is]

number

controlBytesRx[lesserOrEquals] Optional

Filter by controlBytesRx[lesserOrEquals]

number

controlBytesTx[greaterOrEquals] Optional

Filter by controlBytesTx[greaterOrEquals]

number

controlBytesTx[isNot] Optional

Filter by controlBytesTx[isNot]

number

controlBytesTx[is] Optional

Filter by controlBytesTx[is]

number

controlBytesTx[lesserOrEquals] Optional

Filter by controlBytesTx[lesserOrEquals]

number

controlPacketsRx[greaterOrEquals] Optional

Filter by controlPacketsRx[greaterOrEquals]

number

controlPacketsRx[isNot] Optional

Filter by controlPacketsRx[isNot]

number

controlPacketsRx[is] Optional

Filter by controlPacketsRx[is]

number

controlPacketsRx[lesserOrEquals] Optional

Filter by controlPacketsRx[lesserOrEquals]

number

controlPacketsTx[greaterOrEquals] Optional

Filter by controlPacketsTx[greaterOrEquals]

number

controlPacketsTx[isNot] Optional

Filter by controlPacketsTx[isNot]

number

controlPacketsTx[is] Optional

Filter by controlPacketsTx[is]

number

controlPacketsTx[lesserOrEquals] Optional

Filter by controlPacketsTx[lesserOrEquals]

integer

end Optional

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

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

number

p1BytesRx[greaterOrEquals] Optional

Filter by p1BytesRx[greaterOrEquals]

number

p1BytesRx[isNot] Optional

Filter by p1BytesRx[isNot]

number

p1BytesRx[is] Optional

Filter by p1BytesRx[is]

number

p1BytesRx[lesserOrEquals] Optional

Filter by p1BytesRx[lesserOrEquals]

number

p1BytesTx[greaterOrEquals] Optional

Filter by p1BytesTx[greaterOrEquals]

number

p1BytesTx[isNot] Optional

Filter by p1BytesTx[isNot]

number

p1BytesTx[is] Optional

Filter by p1BytesTx[is]

number

p1BytesTx[lesserOrEquals] Optional

Filter by p1BytesTx[lesserOrEquals]

number

p1PacketsRx[greaterOrEquals] Optional

Filter by p1PacketsRx[greaterOrEquals]

number

p1PacketsRx[isNot] Optional

Filter by p1PacketsRx[isNot]

number

p1PacketsRx[is] Optional

Filter by p1PacketsRx[is]

number

p1PacketsRx[lesserOrEquals] Optional

Filter by p1PacketsRx[lesserOrEquals]

number

p1PacketsTx[greaterOrEquals] Optional

Filter by p1PacketsTx[greaterOrEquals]

number

p1PacketsTx[isNot] Optional

Filter by p1PacketsTx[isNot]

number

p1PacketsTx[is] Optional

Filter by p1PacketsTx[is]

number

p1PacketsTx[lesserOrEquals] Optional

Filter by p1PacketsTx[lesserOrEquals]

number

p2BytesRx[greaterOrEquals] Optional

Filter by p2BytesRx[greaterOrEquals]

number

p2BytesRx[isNot] Optional

Filter by p2BytesRx[isNot]

number

p2BytesRx[is] Optional

Filter by p2BytesRx[is]

number

p2BytesRx[lesserOrEquals] Optional

Filter by p2BytesRx[lesserOrEquals]

number

p2BytesTx[greaterOrEquals] Optional

Filter by p2BytesTx[greaterOrEquals]

number

p2BytesTx[isNot] Optional

Filter by p2BytesTx[isNot]

number

p2BytesTx[is] Optional

Filter by p2BytesTx[is]

number

p2BytesTx[lesserOrEquals] Optional

Filter by p2BytesTx[lesserOrEquals]

number

p2PacketsRx[greaterOrEquals] Optional

Filter by p2PacketsRx[greaterOrEquals]

number

p2PacketsRx[isNot] Optional

Filter by p2PacketsRx[isNot]

number

p2PacketsRx[is] Optional

Filter by p2PacketsRx[is]

number

p2PacketsRx[lesserOrEquals] Optional

Filter by p2PacketsRx[lesserOrEquals]

number

p2PacketsTx[greaterOrEquals] Optional

Filter by p2PacketsTx[greaterOrEquals]

number

p2PacketsTx[isNot] Optional

Filter by p2PacketsTx[isNot]

number

p2PacketsTx[is] Optional

Filter by p2PacketsTx[is]

number

p2PacketsTx[lesserOrEquals] Optional

Filter by p2PacketsTx[lesserOrEquals]

number

p3BytesRx[greaterOrEquals] Optional

Filter by p3BytesRx[greaterOrEquals]

number

p3BytesRx[isNot] Optional

Filter by p3BytesRx[isNot]

number

p3BytesRx[is] Optional

Filter by p3BytesRx[is]

number

p3BytesRx[lesserOrEquals] Optional

Filter by p3BytesRx[lesserOrEquals]

number

p3BytesTx[greaterOrEquals] Optional

Filter by p3BytesTx[greaterOrEquals]

number

p3BytesTx[isNot] Optional

Filter by p3BytesTx[isNot]

number

p3BytesTx[is] Optional

Filter by p3BytesTx[is]

number

p3BytesTx[lesserOrEquals] Optional

Filter by p3BytesTx[lesserOrEquals]

number

p3PacketsRx[greaterOrEquals] Optional

Filter by p3PacketsRx[greaterOrEquals]

number

p3PacketsRx[isNot] Optional

Filter by p3PacketsRx[isNot]

number

p3PacketsRx[is] Optional

Filter by p3PacketsRx[is]

number

p3PacketsRx[lesserOrEquals] Optional

Filter by p3PacketsRx[lesserOrEquals]

number

p3PacketsTx[greaterOrEquals] Optional

Filter by p3PacketsTx[greaterOrEquals]

number

p3PacketsTx[isNot] Optional

Filter by p3PacketsTx[isNot]

number

p3PacketsTx[is] Optional

Filter by p3PacketsTx[is]

number

p3PacketsTx[lesserOrEquals] Optional

Filter by p3PacketsTx[lesserOrEquals]

number

packetsRx[greaterOrEquals] Optional

Filter by packetsRx[greaterOrEquals]

number

packetsRx[isNot] Optional

Filter by packetsRx[isNot]

number

packetsRx[is] Optional

Filter by packetsRx[is]

number

packetsRx[lesserOrEquals] Optional

Filter by packetsRx[lesserOrEquals]

number

packetsTx[greaterOrEquals] Optional

Filter by packetsTx[greaterOrEquals]

number

packetsTx[isNot] Optional

Filter by packetsTx[isNot]

number

packetsTx[is] Optional

Filter by packetsTx[is]

number

packetsTx[lesserOrEquals] Optional

Filter by packetsTx[lesserOrEquals]

number

scoreRx[greaterOrEquals] Optional

Filter by scoreRx[greaterOrEquals]

number

scoreRx[isNot] Optional

Filter by scoreRx[isNot]

number

scoreRx[is] Optional

Filter by scoreRx[is]

number

scoreRx[lesserOrEquals] Optional

Filter by scoreRx[lesserOrEquals]

number

scoreTx[greaterOrEquals] Optional

Filter by scoreTx[greaterOrEquals]

number

scoreTx[isNot] Optional

Filter by scoreTx[isNot]

number

scoreTx[is] Optional

Filter by scoreTx[is]

number

scoreTx[lesserOrEquals] Optional

Filter by scoreTx[lesserOrEquals]

number

signalStrength[greaterOrEquals] Optional

Filter by signalStrength[greaterOrEquals]

number

signalStrength[isNot] Optional

Filter by signalStrength[isNot]

number

signalStrength[is] Optional

Filter by signalStrength[is]

number

signalStrength[lesserOrEquals] Optional

Filter by signalStrength[lesserOrEquals]

integer

start Optional

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

number

totalBytes[greaterOrEquals] Optional

Filter by totalBytes[greaterOrEquals]

number

totalBytes[isNot] Optional

Filter by totalBytes[isNot]

number

totalBytes[is] Optional

Filter by totalBytes[is]

number

totalBytes[lesserOrEquals] Optional

Filter by totalBytes[lesserOrEquals]

number

totalPackets[greaterOrEquals] Optional

Filter by totalPackets[greaterOrEquals]

number

totalPackets[isNot] Optional

Filter by totalPackets[isNot]

number

totalPackets[is] Optional

Filter by totalPackets[is]

number

totalPackets[lesserOrEquals] Optional

Filter by totalPackets[lesserOrEquals]

Response

Response Body

200 OK

Returns 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
}

string

autoDualMode Optional

number as float

bestJitterMsRx Optional

number as float

bestJitterMsTx Optional

number as float

bestLatencyMsRx Optional

number as float

bestLatencyMsTx Optional

number as float

bestLossPctRx Optional

number as float

bestLossPctTx Optional

number as float

bpsOfBestPathRx Optional

number as float

bpsOfBestPathTx Optional

number as float

bytesRx Optional

number as float

bytesTx Optional

number as float

controlBytesRx Optional

number as float

controlBytesTx Optional

number as float

controlPacketsRx Optional

number as float

controlPacketsTx Optional

LinkResource

link Optional

string

name Optional

number as float

p1BytesRx Optional

number as float

p1BytesTx Optional

number as float

p1PacketsRx Optional

number as float

p1PacketsTx Optional

number as float

p2BytesRx Optional

number as float

p2BytesTx Optional

number as float

p2PacketsRx Optional

number as float

p2PacketsTx Optional

number as float

p3BytesRx Optional

number as float

p3BytesTx Optional

number as float

p3PacketsRx Optional

number as float

p3PacketsTx Optional

number as float

packetsRx Optional

number as float

packetsTx Optional

number as float

scoreRx Optional

number as float

scoreTx Optional

number as float

signalStrength Optional

number as float

totalBytes Optional

number as float

totalPackets Optional

Errors

ValidationError

400

ValidationError

UnAuthorized

401

Unauthorized

ResourceNotFoundError

404

Resource not found

RateLimitExceededError

429

Rate Limit Exceeded

InternalServerError

500

Internal server error

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/linkStats?metrics=string

[{"label":"Latest (v1.0)","version":"latest"}]

vmware-sase-platform

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 Stats

get

Get Enterprise Flow Metrics

get

Get Enterprise Link Metrics

get

Get Enterprise Nni Metrics

get

Get Enterprise Nni Series

get

Get Enterprises

Get Enterprise Link Metrics

Request

URL

Path Parameters

Query Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Monitor Operations

Was this page helpful?