VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
VMware Sase Platform API VMware SD-WAN Orchestration API v2 Monitor Customers

Get Enterprise Flow Metrics

Description

Fetch Customer-global network flow summary statistics

Request

Request

URL

URL

get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/flowStats
Copy
Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise

Query Parameters

Query Parameters

integer
end Optional

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

groupBy criteria according to which the result set is grouped. For example, a groupBy value of link produces an API response wherein each element corresponds to a distinct link record for which aggregate values are reported.

Possible values are: link , application , applicationClass , destFQDN , sourceMac , destDomain , sourceIp , destIp , destPort

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 Optional

metrics supported for querying flowStats

Possible values are: bytesRx , bytesTx , totalBytes , packetsRx , packetsTx , totalPackets , flowCount

string
sortBy Optional

sortBy query param to sort the resultset. Format of sortBy is <ASC | DESC>
integer
start Required

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

Response

Response

Response Body

Response Body

200 OK

Returns array of FlowStatsResource of type application/json

Request successfully processed

{
	"application": {
		"_href": "string",
		"class": 0,
		"description": "string",
		"displayName": "string",
		"knownIpPortMapping": {},
		"mustNotPerformDpi": 0,
		"name": "string",
		"protocolPortMapping": {}
	},
	"applicationClass": {
		"_href": "string"
	},
	"bytesRx": 0,
	"bytesTx": 0,
	"clientDevice": {
		"_href": "string",
		"created": "string",
		"deviceModel": "string",
		"deviceType": "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"
		},
		"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"
		},
		"hostName": "string",
		"ipAddress": "string",
		"lastContact": "string",
		"logicalId": "string",
		"macAddress": "string",
		"modified": "string",
		"os": 0,
		"osName": "string",
		"osVersion": "string",
		"segmentId": 0
	},
	"destDomain": "string",
	"destFQDN": "string",
	"destIp": "string",
	"destPort": 0,
	"endTime": "string",
	"flowCount": 0,
	"hostName": "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",
			"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
	},
	"nextHop": "string",
	"packetsReceived": 0,
	"packetsRx": 0,
	"packetsSent": 0,
	"packetsTx": 0,
	"retransmits": 0,
	"route": 0,
	"rtt": 0,
	"segment": {
		"_href": "string",
		"alertsEnabled": 0,
		"created": "string",
		"data": {},
		"description": "string",
		"draftComment": "string",
		"draftCreated": "string",
		"draftData": "string",
		"lastContact": "string",
		"modified": "string",
		"name": "string",
		"object": "string",
		"operatorAlertsEnabled": 0,
		"previousCreated": "string",
		"previousData": {},
		"status": "string",
		"statusModified": "string",
		"type": "string",
		"version": "string"
	},
	"sourceIp": "string",
	"startTime": "string",
	"totalBytes": 0,
	"totalPackets": 0,
	"transport": 0
}
ApplicationResource
application Optional
BaseApiResource
applicationClass Optional
number as float
bytesRx Optional
number as float
bytesTx Optional
ClientDeviceResource
clientDevice Optional
string
destDomain Optional
string
destFQDN Optional
string
destIp Optional
number as float
destPort Optional
string as date-time
endTime Optional
number as float
flowCount Optional
string
hostName Optional
LinkResource
link Optional
string
nextHop Optional
number as float
packetsReceived Optional
number as float
packetsRx Optional
number as float
packetsSent Optional
number as float
packetsTx Optional
number as float
retransmits Optional
number as float
route Optional
number as float
rtt Optional
SegmentSchema
segment Optional
string
sourceIp Optional
string as date-time
startTime Optional
number as float
totalBytes Optional
number as float
totalPackets Optional
number as float
transport Optional
Errors

Errors

ValidationError
400

ValidationError
UnAuthorized
401

Unauthorized
ResourceNotFoundError
404

Resource not found
RateLimitExceededError
429

Rate Limit Exceeded
InternalServerError
500

Internal server error
Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/flowStats?groupBy=string&amp;start=10

Generated on: 01 Jun 23 10:48 UTC
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
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 Stats
get
Get Enterprise Flow Metrics
get
Get Enterprise Link Metrics
get
Get Enterprise Nni Metrics
get
Get Enterprise Nni Series
get
Get Enterprises
Feedback

Was this page helpful?

© 2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us