Get Edge Path Series

Get Edge Path Series

Fetch path stats time series from an edge

Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/pathStats/timeSeries
COPY
Path Parameters
string
enterpriseLogicalId
Required

The logicalId GUID for the target enterprise

string
edgeLogicalId
Required

The logicalId GUID for the target edge

Query Parameters
string
include
Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.

string
peerLogicalId
Required

The logicalId GUID for the path stats peer

integer
start
Optional

Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.

integer
end
Optional

Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.

integer
maxSamples
Optional

An integer value specifying the max samples for path stats

string
metrics
Optional

metrics supported for querying pathStats

Possible values are : bytesRx, bytesTx, totalBytes, packetsRx, packetsTx, totalPackets, p1BytesRx, p1BytesTx, p1PacketsRx, p1PacketsTx, p2BytesRx, p2BytesTx, p2PacketsRx, p2PacketsTx, p3BytesRx, p3BytesTx, p3PacketsRx, p3PacketsTx, controlBytesRx, controlBytesTx, controlPacketsRx, controlPacketsTx, bpsRx, bpsRxMin, bpsRxMax, bpsTx, bpsTxMin, bpsTxMax, latencyRx, latencyRxMin, latencyRxMax, latencyTx, latencyTxMin, latencyTxMax, jitterRx, jitterRxMin, jitterRxMax, jitterTx, jitterTxMin, jitterTxMax, packetLossRx, packetLossRxMin, packetLossRxMax, packetLossTx, packetLossTxMin, packetLossTxMax, scoreBeforeVoice, scoreBeforeVideo, scoreBeforeTrans, scoreAfterVoice, scoreAfterVideo, scoreAfterTrans,
integer,null
limit
Optional

Limits the maximum size of the result set.

string
groupBy
Optional

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 : path, peer,
Responses
200

Request successfully processed

Returns Array of EdgePathStatsSeriesResource of type(s) application/json 
[
    {
        "source": {
            "edge": {
                "_href": "string",
                "activationKey": "string",
                "activationKeyExpires": "string",
                "activationState": "string",
                "activationTime": "string",
                "alertsEnabled": false,
                "bastionState": "string",
                "buildNumber": "string",
                "created": "string",
                "customInfo": "string",
                "description": "string",
                "deviceFamily": "string",
                "deviceId": "string",
                "dnsName": "string",
                "edgeState": "string",
                "edgeStateTime": "string",
                "endpointPkiMode": "string",
                "factoryBuildNumber": "string",
                "factorySoftwareVersion": "string",
                "platformBuildNumber": "string",
                "platformFirmwareVersion": "string",
                "modemBuildNumber": "string",
                "modemFirmwareVersion": "string",
                "lteRegion": "string",
                "haLastContact": "string",
                "haPreviousState": "string",
                "haSerialNumber": "string",
                "haState": "string",
                "isLive": false,
                "lastContact": "string",
                "logicalId": "string",
                "modelNumber": "string",
                "modified": "string",
                "name": "string",
                "operatorAlertsEnabled": false,
                "selfMacAddress": "string",
                "serialNumber": "string",
                "serviceState": "string",
                "serviceUpSince": "string",
                "softwareUpdated": "string",
                "softwareVersion": "string",
                "systemUpSince": "string",
                "links": [
                    {
                        "_href": "string"
                    }
                ],
                "site": {
                    "_href": "string",
                    "created": "string",
                    "name": "string",
                    "contactName": "string",
                    "contactPhone": "string",
                    "contactMobile": "string",
                    "contactEmail": "string",
                    "streetAddress": "string",
                    "streetAddress2": "string",
                    "city": "string",
                    "state": "string",
                    "country": "string",
                    "postalCode": "string",
                    "lat": "number",
                    "lon": "number",
                    "timezone": "string",
                    "locale": "string",
                    "shippingSameAsLocation": false,
                    "shippingContactName": "string",
                    "shippingAddress": "string",
                    "shippingAddress2": "string",
                    "shippingCity": "string",
                    "shippingState": "string",
                    "shippingCountry": "string",
                    "shippingPostalCode": "string",
                    "modified": "string"
                },
                "enterprise": {
                    "_href": "string",
                    "created": "string",
                    "alertsEnabled": false,
                    "operatorAlertsEnabled": false,
                    "endpointPkiMode": "string",
                    "name": "string",
                    "domain": "string",
                    "prefix": "string",
                    "logicalId": "string",
                    "accountNumber": "string",
                    "description": "string",
                    "contactName": "string",
                    "contactPhone": "string",
                    "contactMobile": "string",
                    "contactEmail": "string",
                    "streetAddress": "string",
                    "streetAddress2": "string",
                    "city": "string",
                    "state": "string",
                    "postalCode": "string",
                    "country": "string",
                    "lat": "number",
                    "lon": "number",
                    "timezone": "string",
                    "locale": "string",
                    "modified": "string",
                    "gatewayPool": {
                        "_href": "string"
                    },
                    "bastionState": "string"
                },
                "haMode": "string",
                "standbySystemUpSince": "string",
                "standbyServiceUpSince": "string",
                "standbySoftwareVersion": "string",
                "standbyFactorySoftwareVersion": "string",
                "standbyFactoryBuildNumber": "string",
                "standbyBuildNumber": "string",
                "standbyModelNumber": "string",
                "standbyDeviceId": "string"
            },
            "link": {
                "_href": "string",
                "created": "string",
                "edge": {
                    "_href": "string",
                    "activationKey": "string",
                    "activationKeyExpires": "string",
                    "activationState": "string",
                    "activationTime": "string",
                    "alertsEnabled": false,
                    "bastionState": "string",
                    "buildNumber": "string",
                    "created": "string",
                    "customInfo": "string",
                    "description": "string",
                    "deviceFamily": "string",
                    "deviceId": "string",
                    "dnsName": "string",
                    "edgeState": "string",
                    "edgeStateTime": "string",
                    "endpointPkiMode": "string",
                    "factoryBuildNumber": "string",
                    "factorySoftwareVersion": "string",
                    "platformBuildNumber": "string",
                    "platformFirmwareVersion": "string",
                    "modemBuildNumber": "string",
                    "modemFirmwareVersion": "string",
                    "lteRegion": "string",
                    "haLastContact": "string",
                    "haPreviousState": "string",
                    "haSerialNumber": "string",
                    "haState": "string",
                    "isLive": false,
                    "lastContact": "string",
                    "logicalId": "string",
                    "modelNumber": "string",
                    "modified": "string",
                    "name": "string",
                    "operatorAlertsEnabled": false,
                    "selfMacAddress": "string",
                    "serialNumber": "string",
                    "serviceState": "string",
                    "serviceUpSince": "string",
                    "softwareUpdated": "string",
                    "softwareVersion": "string",
                    "systemUpSince": "string",
                    "links": [
                        {
                            "_href": "string"
                        }
                    ],
                    "site": {
                        "_href": "string",
                        "created": "string",
                        "name": "string",
                        "contactName": "string",
                        "contactPhone": "string",
                        "contactMobile": "string",
                        "contactEmail": "string",
                        "streetAddress": "string",
                        "streetAddress2": "string",
                        "city": "string",
                        "state": "string",
                        "country": "string",
                        "postalCode": "string",
                        "lat": "number",
                        "lon": "number",
                        "timezone": "string",
                        "locale": "string",
                        "shippingSameAsLocation": false,
                        "shippingContactName": "string",
                        "shippingAddress": "string",
                        "shippingAddress2": "string",
                        "shippingCity": "string",
                        "shippingState": "string",
                        "shippingCountry": "string",
                        "shippingPostalCode": "string",
                        "modified": "string"
                    },
                    "enterprise": {
                        "_href": "string",
                        "created": "string",
                        "alertsEnabled": false,
                        "operatorAlertsEnabled": false,
                        "endpointPkiMode": "string",
                        "name": "string",
                        "domain": "string",
                        "prefix": "string",
                        "logicalId": "string",
                        "accountNumber": "string",
                        "description": "string",
                        "contactName": "string",
                        "contactPhone": "string",
                        "contactMobile": "string",
                        "contactEmail": "string",
                        "streetAddress": "string",
                        "streetAddress2": "string",
                        "city": "string",
                        "state": "string",
                        "postalCode": "string",
                        "country": "string",
                        "lat": "number",
                        "lon": "number",
                        "timezone": "string",
                        "locale": "string",
                        "modified": "string",
                        "gatewayPool": {
                            "_href": "string"
                        },
                        "bastionState": "string"
                    },
                    "haMode": "string",
                    "standbySystemUpSince": "string",
                    "standbyServiceUpSince": "string",
                    "standbySoftwareVersion": "string",
                    "standbyFactorySoftwareVersion": "string",
                    "standbyFactoryBuildNumber": "string",
                    "standbyBuildNumber": "string",
                    "standbyModelNumber": "string",
                    "standbyDeviceId": "string"
                },
                "logicalId": "string",
                "internalId": "string",
                "interface": "string",
                "macAddress": "string",
                "ipAddress": "string",
                "ipV6Address": "string",
                "netmask": "string",
                "networkSide": "string",
                "networkType": "string",
                "displayName": "string",
                "userOverride": false,
                "isp": "string",
                "org": "string",
                "lat": "number",
                "lon": "number",
                "lastActive": "string",
                "state": "string",
                "backupState": "string",
                "linkMode": "string",
                "lastEvent": "string",
                "lastEventState": "string",
                "alertsEnabled": false,
                "operatorAlertsEnabled": false,
                "serviceState": "string",
                "modified": "string"
            }
        },
        "timeSeries": [
            {
                "data": [
                    {}
                ],
                "metric": "string",
                "average": 0,
                "median": 0,
                "startTime": "number",
                "tickInterval": "number",
                "distribution": {
                    "OFFLINE": 0,
                    "UNKNOWN": 0,
                    "RED": 0,
                    "YELLOW": 0,
                    "GREEN": 0
                }
            }
        ]
    }
]

400

ValidationError

Returns ValidationError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string",
    "errors": [
        {
            "message": "string",
            "path": "string"
        }
    ]
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation

array of ValidationErrorListItem
errors
Optional

A list of property-specific errors


401

Unauthorized

Returns UnAuthorized of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


404

Resource not found

Returns ResourceNotFoundError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


429

Rate Limit Exceeded

Returns RateLimitExceededError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


500

Internal server error

Returns InternalServerError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


On This Page
Monitor Operations
GET
Get Edge Application
GET
Get Edge Applications
GET
Get Edge Firewall Idps Stats Series
GET
Get Edge Flow Metrics
GET
Get Edge Flow Series
GET
Get Edge Health Metrics
GET
Get Edge Health Series
GET
Get Edge Link Metrics
GET
Get Edge Link Quality Events
GET
Get Edge Link Quality Series
GET
Get Edge Link Series
GET
Get Edge Path Metrics
GET
Get Edge Path Series
GET
Get Enterprise Edge
GET
Get Enterprise Edges