Get Edge Flow Series
DescriptionFetch edge flow stats series
Request
URLURL
Path Parameters
Path Parameters
The logicalId GUID for the target enterprise
The logicalId GUID for the target edge
Query Parameters
Query Parameters
Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.
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 , clientDevice , applicationClass , destFQDN , destIp , destPort , destDomain
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
metrics supported for querying flowStats
Possible values are: bytesRx , bytesTx , totalBytes , packetsRx , packetsTx , totalPackets , flowCount
sortBy query param to sort the resultset. Format of sortBy is
Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.
Response
Response BodyResponse Body
200 OK
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",
"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,
"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
},
"series": [
{
"data": 0,
"max": 0,
"metric": "string",
"min": 0,
"startTime": "string",
"tickInterval": 0,
"total": 0
}
]
}
Errors
ValidationError
Unauthorized
Resource not found
Rate Limit Exceeded
Internal server error
