Metrics Get Edge Flow Visibility Metrics

Metrics Get Edge Flow Visibility Metrics

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

Privileges required:

READ EDGE

VIEW_FLOW_STATS undefined

Request
URI
POST
https://{api_host}/portal/rest/metrics/getEdgeFlowVisibilityMetrics
COPY
Request Body
metrics_get_edge_flow_visibility_metrics of type(s) application/json
Required

Show optional properties

{
    "interval": {
        "start": "string"
    }
}
{
    "id": 0,
    "edgeId": 0,
    "enterpriseId": 0,
    "interval": {
        "end": "string",
        "start": "string"
    },
    "metrics": [
        "string"
    ],
    "sort": "string",
    "quickSearch": "string",
    "filters": {},
    "limit": 0,
    "sortBy": [
        {
            "attribute": "string",
            "type": "string"
        }
    ],
    "nextPageLink": "string",
    "prevPageLink": "string",
    "_count": false,
    "_filterSpec": false
}
integer
id
Optional

id

integer
edgeId
Optional

edgeId

integer
enterpriseId
Optional

enterpriseId

object
interval
Required

interval

array of string
metrics
Optional

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

Possible values are : packetsRx, packetsTx, totalPackets, bytesRx, bytesTx, totalBytes, bestJitterMsRx, bestJitterMsTx, bestLatencyMsRx, bestLatencyMsTx, bestLossPctRx, bestLossPctTx,
string
sort
Optional

sort

Possible values are : packetsRx, packetsTx, totalPackets, bytesRx, bytesTx, totalBytes, bestJitterMsRx, bestJitterMsTx, bestLatencyMsRx, bestLatencyMsTx, bestLossPctRx, bestLossPctTx,
string
quickSearch
Optional
Constraints: minLength: 1

quickSearch

object
filters
Optional

filters

integer
limit
Optional
Constraints: minimum: 0 default: 2048

limit

array of object
sortBy
Optional

sortBy

string
nextPageLink
Optional

nextPageLink

string
prevPageLink
Optional

prevPageLink

boolean
_count
Optional

_count

boolean
_filterSpec
Optional

_filterSpec

Responses
200

Request was successfully processed

Returns Array of metrics_get_edge_flow_visibility_metrics_result_item of type(s) application/json 
[
    "metrics_get_edge_flow_visibility_metrics_result_item Object"
]

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 '{"interval:"object"}' https://{api_host}/portal/rest/metrics/getEdgeFlowVisibilityMetrics
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