Metrics Get Edge Link Metrics

Metrics Get Edge Link Metrics

Fetches summary transport metrics by link for the specified Edge over the specified time interval. On success, this method returns an array where each entry corresponds to a WAN link for which the Edge reported some activity over the time period covered by the request interval.

Privileges required:

READ EDGE

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

Show optional properties

{
    "interval": {
        "start": 1609459200000,
        "end": 1609459920000
    }
}
{
    "id": 0,
    "edgeId": 0,
    "enterpriseId": 0,
    "interval": {
        "end": "string",
        "start": "string"
    },
    "metrics": [
        "edge_link_metric Object"
    ],
    "sort": "edge_link_metric Object",
    "limit": 0,
    "links": [
        0
    ]
}
integer
id
Optional

Alias for edgeId

integer
edgeId
Optional

edgeId

integer
enterpriseId
Optional

enterpriseId

interval
interval
Required

interval

array of edge_link_metric
metrics
Optional

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

edge_link_metric
sort
Optional

sort

Possible values are : bytesRx, bytesTx, totalBytes, totalPackets, p1BytesRx, p1BytesTx, p1PacketsRx, p1PacketsTx, p2BytesRx, p2BytesTx, p2PacketsRx, p2PacketsTx, p3BytesRx, p3BytesTx, p3PacketsRx, p3PacketsTx, packetsRx, packetsTx, controlBytesRx, controlBytesTx, controlPacketsRx, controlPacketsTx, bestBwKbpsRx, bestBwKbpsTx, bestJitterMsRx, bestJitterMsTx, bestLatencyMsRx, bestLatencyMsTx, bestLossPctRx, bestLossPctTx, bpsOfBestPathRx, bpsOfBestPathTx, signalStrength, scoreTx, scoreRx,
integer
limit
Optional

limit

array of integer
links
Optional

links

Responses
200

Request was successfully processed

[
    "metrics_get_edge_link_metrics_result_item Object"
]
array of metrics_get_edge_link_metrics_result_item
Optional

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/getEdgeLinkMetrics
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 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 Flow Metrics
POST
Metrics Get Gateway Status Metrics
POST
Metrics Get Gateway Status Series