Metrics Get Edge Sdwan Peer Path Series

Metrics Get Edge Sdwan Peer Path Series

Gets path stats metric time series data for the specified time interval by path. On success, this method returns an array of path stats data in which each entry corresponds to a single path. The enterpriseId property is required when this method is invoked in the operator context.

Privileges required:

READ EDGE

VIEW_PATH_STATS undefined

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

Show optional properties

{
    "edgeId": 0,
    "peerLogicalId": "string"
}
{
    "edgeId": 0,
    "enterpriseId": 0,
    "peerLogicalId": "string",
    "paths": [
        {
            "srcLinkLogicalId": "string",
            "destLinkLogicalId": "string"
        }
    ],
    "interval": {
        "end": "string",
        "start": "string"
    },
    "maxSamples": 0,
    "metrics": "path_metrics Object",
    "limit": 0,
    "viewBy": "string",
    "_filterSpec": false
}
integer
edgeId
Required

edgeId

integer
enterpriseId
Optional

enterpriseId

string
peerLogicalId
Required

peerLogicalId

array of object
paths
Optional

paths

interval
interval
Optional

interval

integer
maxSamples
Optional
Constraints: default: 1024

maxSamples

path_metrics
metrics
Optional

metrics

integer
limit
Optional
Constraints: default: 16

limit

string
viewBy
Optional
Constraints: default: path

viewBy

Possible values are : path, peer,
boolean
_filterSpec
Optional

_filterSpec

Responses
200

Request was successfully processed

Returns Array of metrics_get_edge_sdwan_peer_path_series_result_item of type(s) application/json 
[
    "metrics_get_edge_sdwan_peer_path_series_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 '{"edgeId:"integer","peerLogicalId:"string"}' https://{api_host}/portal/rest/metrics/getEdgeSDWANPeerPathSeries
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