Get Enterprise Flow Metrics
Fetch Customer-global network flow summary statistics
Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/flowStats
COPY
Path Parameters
string
enterpriseLogicalId
Required
The logicalId GUID for the target enterprise
Query Parameters
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
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,
integer
start
Required
Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.
integer
end
Optional
Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.
string
sortBy
Optional
sortBy query param to sort the resultset. Format of sortBy is
string
metrics
Optional
metrics supported for querying flowStats
Possible values are : bytesRx, bytesTx, totalBytes, packetsRx, packetsTx, totalPackets, flowCount,
Responses
200
Request successfully processed
Returns Array of object of type(s) application/json
[
{
"bytesRx": "number",
"bytesTx": "number",
"totalBytes": "number",
"packetsRx": "number",
"packetsTx": "number",
"totalPackets": "number",
"flowCount": "number",
"link": {
"_href": "string",
"created": "string",
"logicalId": "string",
"internalId": "string",
"interface": "string",
"macAddress": "string",
"ipAddress": "string",
"ipV6Address": "string",
"netmask": "string",
"networkSide": "string",
"networkType": "string",
"displayName": "string",
"userOverride": false,
"isp": "string",
"org": "string",
"lat": "number",
"lon": "number",
"lastActive": "string",
"state": "string",
"backupState": "string",
"linkMode": "string",
"lastEvent": "string",
"lastEventState": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"serviceState": "string",
"modified": "string",
"edge": {
"_href": "string",
"activationKey": "string",
"activationKeyExpires": "string",
"activationState": "string",
"activationTime": "string",
"alertsEnabled": false,
"bastionState": "string",
"buildNumber": "string",
"created": "string",
"customInfo": "string",
"description": "string",
"deviceFamily": "string",
"deviceId": "string",
"dnsName": "string",
"edgeState": "string",
"edgeStateTime": "string",
"endpointPkiMode": "string",
"factoryBuildNumber": "string",
"factorySoftwareVersion": "string",
"platformBuildNumber": "string",
"platformFirmwareVersion": "string",
"modemBuildNumber": "string",
"modemFirmwareVersion": "string",
"lteRegion": "string",
"haLastContact": "string",
"haPreviousState": "string",
"haSerialNumber": "string",
"haState": "string",
"isLive": false,
"lastContact": "string",
"logicalId": "string",
"modelNumber": "string",
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"selfMacAddress": "string",
"serialNumber": "string",
"serviceState": "string",
"serviceUpSince": "string",
"softwareUpdated": "string",
"softwareVersion": "string",
"systemUpSince": "string",
"links": [
{
"_href": "string",
"created": "string",
"logicalId": "string",
"internalId": "string",
"interface": "string",
"macAddress": "string",
"ipAddress": "string",
"ipV6Address": "string",
"netmask": "string",
"networkSide": "string",
"networkType": "string",
"displayName": "string",
"userOverride": false,
"isp": "string",
"org": "string",
"lat": "number",
"lon": "number",
"lastActive": "string",
"state": "string",
"backupState": "string",
"linkMode": "string",
"lastEvent": "string",
"lastEventState": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"serviceState": "string",
"modified": "string"
}
],
"site": {
"_href": "string",
"created": "string",
"name": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"shippingSameAsLocation": false,
"shippingContactName": "string",
"shippingAddress": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingState": "string",
"shippingCountry": "string",
"shippingPostalCode": "string",
"modified": "string"
},
"enterprise": {
"_href": "string",
"created": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"endpointPkiMode": "string",
"name": "string",
"domain": "string",
"prefix": "string",
"logicalId": "string",
"accountNumber": "string",
"description": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"modified": "string",
"gatewayPool": {
"_href": "string"
},
"bastionState": "string"
},
"haMode": "string",
"standbySystemUpSince": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbyFactorySoftwareVersion": "string",
"standbyFactoryBuildNumber": "string",
"standbyBuildNumber": "string",
"standbyModelNumber": "string",
"standbyDeviceId": "string"
}
},
"clientDevice": {
"_href": "string",
"logicalId": "string",
"created": "string",
"enterprise": {
"_href": "string",
"created": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"endpointPkiMode": "string",
"name": "string",
"domain": "string",
"prefix": "string",
"logicalId": "string",
"accountNumber": "string",
"description": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"modified": "string",
"gatewayPool": {
"_href": "string"
},
"bastionState": "string"
},
"edge": {
"_href": "string",
"activationKey": "string",
"activationKeyExpires": "string",
"activationState": "string",
"activationTime": "string",
"alertsEnabled": false,
"bastionState": "string",
"buildNumber": "string",
"created": "string",
"customInfo": "string",
"description": "string",
"deviceFamily": "string",
"deviceId": "string",
"dnsName": "string",
"edgeState": "string",
"edgeStateTime": "string",
"endpointPkiMode": "string",
"factoryBuildNumber": "string",
"factorySoftwareVersion": "string",
"platformBuildNumber": "string",
"platformFirmwareVersion": "string",
"modemBuildNumber": "string",
"modemFirmwareVersion": "string",
"lteRegion": "string",
"haLastContact": "string",
"haPreviousState": "string",
"haSerialNumber": "string",
"haState": "string",
"isLive": false,
"lastContact": "string",
"logicalId": "string",
"modelNumber": "string",
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"selfMacAddress": "string",
"serialNumber": "string",
"serviceState": "string",
"serviceUpSince": "string",
"softwareUpdated": "string",
"softwareVersion": "string",
"systemUpSince": "string",
"links": [
{
"_href": "string",
"created": "string",
"logicalId": "string",
"internalId": "string",
"interface": "string",
"macAddress": "string",
"ipAddress": "string",
"ipV6Address": "string",
"netmask": "string",
"networkSide": "string",
"networkType": "string",
"displayName": "string",
"userOverride": false,
"isp": "string",
"org": "string",
"lat": "number",
"lon": "number",
"lastActive": "string",
"state": "string",
"backupState": "string",
"linkMode": "string",
"lastEvent": "string",
"lastEventState": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"serviceState": "string",
"modified": "string"
}
],
"site": {
"_href": "string",
"created": "string",
"name": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"shippingSameAsLocation": false,
"shippingContactName": "string",
"shippingAddress": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingState": "string",
"shippingCountry": "string",
"shippingPostalCode": "string",
"modified": "string"
},
"enterprise": {
"_href": "string",
"created": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"endpointPkiMode": "string",
"name": "string",
"domain": "string",
"prefix": "string",
"logicalId": "string",
"accountNumber": "string",
"description": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"modified": "string",
"gatewayPool": {
"_href": "string"
},
"bastionState": "string"
},
"haMode": "string",
"standbySystemUpSince": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbyFactorySoftwareVersion": "string",
"standbyFactoryBuildNumber": "string",
"standbyBuildNumber": "string",
"standbyModelNumber": "string",
"standbyDeviceId": "string"
},
"macAddress": "string",
"hostName": "string",
"ipAddress": "string",
"segmentId": 0,
"os": 0,
"osName": "string",
"osVersion": "string",
"deviceType": "string",
"deviceModel": "string",
"lastContact": "string",
"modified": "string"
},
"application": {
"_href": "string",
"name": "string",
"displayName": "string",
"class": 0,
"description": "string",
"knownIpPortMapping": {},
"protocolPortMapping": {},
"mustNotPerformDpi": 0
},
"applicationClass": {
"_href": "string"
},
"segment": {
"_href": "string",
"created": "string",
"description": "string",
"object": "string",
"name": "string",
"type": "string",
"alertsEnabled": 0,
"operatorAlertsEnabled": 0,
"status": "string",
"statusModified": "string",
"previousData": {},
"previousCreated": "string",
"draftData": "string",
"draftCreated": "string",
"draftComment": "string",
"data": {},
"lastContact": "string",
"version": "string",
"modified": "string"
},
"destFQDN": "string",
"destIp": "string",
"destPort": "number",
"destDomain": "string",
"sourceIp": "string",
"retransmits": "number",
"rtt": "number",
"transport": "number",
"nextHop": "string",
"hostName": "string",
"route": "number",
"packetsReceived": "number",
"packetsSent": "number",
"startTime": "string",
"endTime": "string"
}
]
400
ValidationError
Returns ValidationError of type(s) application/json
"ValidationError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
array of object
errors
Optional
A list of property-specific errors
401
Unauthorized
Returns UnAuthorized of type(s) application/json
"UnAuthorized Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
404
Resource not found
Returns ResourceNotFoundError of type(s) application/json
"ResourceNotFoundError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
429
Rate Limit Exceeded
Returns RateLimitExceededError of type(s) application/json
"RateLimitExceededError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
500
Internal server error
Returns InternalServerError of type(s) application/json
"InternalServerError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/flowStats?groupBy=value&start=v
Monitor Operations
GET
Get Enterprises
POST
Create Enterprise
GET
Get Enterprise
DELETE
Delete Enterprise
GET
Get Enterprise Flow Metrics
GET
Get Enterprise Applications
GET
Get Enterprise Application By Id
GET
Get Enterprise Link Metrics
GET
Get Enterprise Aggregate Health Stats
GET
Get Enterprise Nni Metrics
GET
Get Enterprise Nni Series
GET
Get Enterprise Firewall Edge Summary Metrics