Get Enterprise Nni Metrics

Get Enterprise Nni Metrics

Fetch all Gateway NNI Metrics for the target customer

Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/nniStats
COPY
Path Parameters
string
enterpriseLogicalId
Required

The logicalId GUID for the target enterprise

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
metrics
Optional

metrics supported for querying nniStats

Possible values are : bytesRx, bytesTx, packetsRx, packetsTx, errorsRx, errorsTx, dropsRx, dropsTx,
integer
start
Required

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.

number
bytesTx[is]
Optional

Filter by bytesTx[is]

number
bytesTx[isNot]
Optional

Filter by bytesTx[isNot]

number
bytesTx[greaterOrEquals]
Optional

Filter by bytesTx[greaterOrEquals]

number
bytesTx[lesserOrEquals]
Optional

Filter by bytesTx[lesserOrEquals]

number
bytesRx[is]
Optional

Filter by bytesRx[is]

number
bytesRx[isNot]
Optional

Filter by bytesRx[isNot]

number
bytesRx[greaterOrEquals]
Optional

Filter by bytesRx[greaterOrEquals]

number
bytesRx[lesserOrEquals]
Optional

Filter by bytesRx[lesserOrEquals]

number
packetsTx[is]
Optional

Filter by packetsTx[is]

number
packetsTx[isNot]
Optional

Filter by packetsTx[isNot]

number
packetsTx[greaterOrEquals]
Optional

Filter by packetsTx[greaterOrEquals]

number
packetsTx[lesserOrEquals]
Optional

Filter by packetsTx[lesserOrEquals]

number
packetsRx[is]
Optional

Filter by packetsRx[is]

number
packetsRx[isNot]
Optional

Filter by packetsRx[isNot]

number
packetsRx[greaterOrEquals]
Optional

Filter by packetsRx[greaterOrEquals]

number
packetsRx[lesserOrEquals]
Optional

Filter by packetsRx[lesserOrEquals]

Responses
200

Request successfully processed

Returns Array of EnterpriseNniStatsResource of type(s) application/json 
[
    {
        "gateway": {
            "_href": "string",
            "id": "number",
            "created": "string",
            "networkId": 0,
            "enterpriseProxyId": 0,
            "siteId": 0,
            "activationKey": "string",
            "activationState": "string",
            "activationTime": "string",
            "softwareVersion": "string",
            "buildNumber": "string",
            "utilization": "number",
            "utilizationDetail": {},
            "connectedEdges": 0,
            "connectedEdgeList": [
                {}
            ],
            "dataCenterVpnStates": "string",
            "deviceId": "string",
            "logicalId": "string",
            "name": "string",
            "gatewayState": "string",
            "alertsEnabled": false,
            "description": "string",
            "dnsName": "string",
            "isLoadBalanced": false,
            "privateIpAddress": "string",
            "ipAddress": "string",
            "ipV6Address": "string",
            "lastContact": "string",
            "systemUpSince": "string",
            "serviceUpSince": "string",
            "serviceState": "string",
            "bastionState": "string",
            "endpointPkiMode": "string",
            "handOffDetail": {},
            "ipsecGatewayDetail": {},
            "modified": "string"
        },
        "segmentLogicalId": "string",
        "vniId": 0,
        "bytesTx": 0,
        "bytesRx": 0,
        "packetsTx": 0,
        "packetsRx": 0,
        "errorsTx": 0,
        "errorsRx": 0,
        "dropsTx": 0,
        "dropsRx": 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
POST
Create Enterprise
DELETE
Delete Enterprise
GET
Get Enterprise
GET
Get Enterprise Aggregate Health Stats
GET
Get Enterprise Application By Id
GET
Get Enterprise Applications
GET
Get Enterprise Firewall Edge Summary Metrics
GET
Get Enterprise Flow Metrics
GET
Get Enterprise Link Metrics
GET
Get Enterprise Nni Metrics
GET
Get Enterprise Nni Series
GET
Get Enterprises