Get Edge Health Series

• Monitor
• Edges

Fetch system resource metric time series data

Request

URI

GET

https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/healthStats/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.

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.

string

metrics

Optional

metrics

Possible values are : tunnelCount, memoryPct, flowCount, cpuPct, cpuCoreTemp, handoffQueueDrops, tunnelCountV6,

---

Responses

200

Hide Details

Request successfully processed

Returns EdgeHealthStatsSeriesSchema of type(s) application/json

{
    "_href": "string",
    "series": [
        {
            "metric": "string",
            "startTime": "string",
            "tickInterval": "number",
            "data": [
                {}
            ],
            "total": "number",
            "min": "number",
            "max": "number"
        }
    ]
}

string

_href

Optional

_href

array of EdgeHealthStatsSeriesResource

series

Optional

series

400

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Description

Request

Path Parameters

Query Parameters

Response

200 Response Body

Errors

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