Changed1
[{"label":"Latest (2022-09-01)","version":"latest"},{"version":"v1.0"}]
vmware-sase-platform

Get Edge Flow Series

Description

Fetch edge flow stats series

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/flowStats/timeSeries
Copy

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


string
edgeLogicalId Required

The logicalId GUID for the target edge


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.


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 flowStats


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 FlowStatsSeriesRecord 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"
	},
	"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",
			"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"
		},
		"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,
	"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
	},
	"series": [
		{
			"data": [
				0
			],
			"max": 0,
			"metric": "string",
			"min": 0,
			"startTime": "string",
			"tickInterval": 0,
			"total": 0
		}
	]
}
application Optional

applicationClass Optional

clientDevice Optional

string
destDomain Optional

string
destFQDN Optional

string
destIp Optional

number as float
destPort Optional

link Optional

series Optional
Errors

Errors

400

ValidationError


401

Unauthorized


404

Resource not found


429

Rate Limit Exceeded


500

Internal server error

Code Samples

Code Samples

cURL Command

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


[{"label":"Latest (2022-09-01)","version":"latest"},{"version":"v1.0"}]
vmware-sase-platform
What's changed in latest?
CHANGED (1)
Response Body Changes
type Changed from
Array&lt;InlineflowStatsSeries_Array&gt; to Array&lt;FlowStatsSeriesRecord&gt;

Feedback

Was this page helpful?