Metrics Get Enterprise Flow Metrics

Metrics Get Enterprise Flow Metrics

Gets flow metric summaries for the enterprise over the specified time interval by specified dimension. On success, this method returns an array of flow data in which each entry corresponds to a single dimension.

Privileges required:

READ EDGE

VIEW_FLOW_STATS undefined

Request
URI
POST
https://{api_host}/portal/rest/metrics/getEnterpriseFlowMetrics
COPY
Request Body

Show optional properties

{
    "interval": {
        "start": 1609459200000,
        "end": 1609459920000
    },
    "viewBy": "application"
}
{
    "enterpriseId": 0,
    "interval": {
        "end": "string",
        "start": "string"
    },
    "metrics": "basic_metrics Object",
    "sort": "basic_metric Object",
    "limit": 0,
    "viewBy": "string"
}
integer
enterpriseId
Optional

enterpriseId

interval
interval
Required

interval

basic_metrics
metrics
Optional

A list of metrics to report. When omitted, this method returns all available metrics.

basic_metric
sort
Optional

sort

Possible values are : packetsRx, packetsTx, totalPackets, bytesRx, bytesTx, totalBytes,
integer
limit
Optional

limit

string
viewBy
Required

viewBy

Responses
200

Request was successfully processed

Returns Array of metrics_get_edge_app_metrics_result_item of type(s) application/json 
[
    {
        "bytesRx": 38976,
        "bytesTx": 26545,
        "packetsRx": 192,
        "packetsTx": 193,
        "flowCount": 871376,
        "application": 32,
        "category": 13,
        "name": 32,
        "totalBytes": 65521,
        "totalPackets": 385
    },
    {
        "bytesRx": 15542,
        "bytesTx": 21828,
        "packetsRx": 67,
        "packetsTx": 88,
        "flowCount": 32,
        "application": 51,
        "category": 6,
        "name": 51,
        "totalBytes": 37370,
        "totalPackets": 155
    },
    {
        "bytesRx": 86663,
        "bytesTx": 3440,
        "packetsRx": 69,
        "packetsTx": 51,
        "flowCount": 5,
        "application": 67,
        "category": 19,
        "name": 67,
        "totalBytes": 90103,
        "totalPackets": 120
    },
    {
        "name": "other",
        "count": 42,
        "metrics": {
            "bytesRx": 62912015,
            "bytesTx": 6780722,
            "packetsRx": 59092,
            "packetsTx": 48571,
            "flowCount": 1063980
        }
    }
]

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"viewBy:"string","interval:"object"}' https://{api_host}/portal/rest/metrics/getEnterpriseFlowMetrics
On This Page
All Operations
POST
Metrics Get Edge App Link Metrics
POST
Metrics Get Edge App Link Series
POST
Metrics Get Edge App Metrics
POST
Metrics Get Edge App Series
POST
Metrics Get Edge Category Metrics
POST
Metrics Get Edge Category Series
POST
Metrics Get Edge Dest Metrics
POST
Metrics Get Edge Dest Series
POST
Metrics Get Edge Device Metrics
POST
Metrics Get Edge Device Series
POST
Metrics Get Edge Flow Visibility Metrics
POST
Metrics Get Edge Link Metrics
POST
Metrics Get Edge Link Series
POST
Metrics Get Edge Os Metrics
POST
Metrics Get Edge Os Series
POST
Metrics Get Edge Sdwan Peer Path Metrics
POST
Metrics Get Edge Sdwan Peer Path Series
POST
Metrics Get Edge Segment Metrics
POST
Metrics Get Edge Segment Series
POST
Metrics Get Edge Status Metrics
POST
Metrics Get Edge Status Series
POST
Metrics Get Enterprise Firewall Edge Count Metrics
POST
Metrics Get Enterprise Flow Metrics
POST
Metrics Get Gateway Status Metrics
POST
Metrics Get Gateway Status Series