Get Enterprise Flow Metrics
Fetch Customer-global network flow summary statistics
The logicalId
GUID for the target enterprise
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
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.
Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.
Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.
sortBy query param to sort the resultset. Format of sortBy is
metrics supported for querying flowStats
Request successfully processed
[
{
"bytesRx": "number",
"bytesTx": "number",
"totalBytes": "number",
"packetsRx": "number",
"packetsTx": "number",
"totalPackets": "number",
"flowCount": "number",
"link": {
"_href": "string",
"created": "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"
}
],
"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"
},
"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"
},
"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"
}
],
"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"
}
]
ValidationError
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string",
"errors": [
{
"message": "string",
"path": "string"
}
]
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Unauthorized
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Resource not found
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Rate Limit Exceeded
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Internal server error
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation