Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET statisticsLink/links/metrics/{metric}

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Fetches performance data of a given link and counter name. Example: /op/statisticsLink/links/metrics/PswdAvailability?linkId=1640554&maxResults=24&timeInterval=6&endpointName=PW_267_8.8.8.8&deviceId=1548600_10.56.23.49

Since Product Version: 2.0

Resource URL

/webacs/api/v1/op/statisticsLink/links/metrics/{metric}

Request Parameters

Type Attribute Name Source Description

String

metric optional

path

Metric

String

linkName optional

query

Link name

Long

linkId optional

query

Link id

String

linkType optional

query

Link Type

Double

timeInterval optional

query

Time interval in hours

Long

maxResults optional

query

Max results

String

location optional

query

Location

String

deviceId optional

query

Device id

String

endpointName optional

query

Endpoint name

Response Parameters

Type Attribute Name Description

String

currentDateTime

Current timestamp

String

description

Metric description

String

metricName

Metric name

MetricRowDTO[]

metricRows

Metric data list

String

resourceName

Resource name

XValueProperty

xValueProperty

Properties of X values

YValueProperty[]

yValueProperty

Properties of Y values

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Response Payload

https://172.25.123.114/webacs/api/v1/op/statisticsLink/links/metrics/{metric}

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsLink/links/metrics/{metric}" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <metricData>
    <currentDateTime>String value</currentDateTime>
    <description>String value</description>
    <metricName>String value</metricName>
    <metricRows>
      <metricRows>
        <issue>String value</issue>
        <XValue>String value</XValue>
        <YLabels>
          <YLabels>String value</YLabels>
        </YLabels>
        <YValues>
          <YValues>15.0</YValues>
        </YValues>
      </metricRows>
    </metricRows>
    <resourceName>String value</resourceName>
    <XValueProperty>
      <label>String value</label>
      <unit>NUMBER</unit>
    </XValueProperty>
    <YValueProperty>
      <YValueProperty>
        <label>String value</label>
        <maxVal>4.0</maxVal>
        <minVal>4.0</minVal>
        <unit>NUMBER</unit>
      </YValueProperty>
    </YValueProperty>
  </metricData>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/statisticsLink/links/metrics/{metric}.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsLink\/links\/metrics\/{
      metric
    }",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "metricData" : {
      "currentDateTime" : "String value",
      "description" : "String value",
      "metricName" : "String value",
      "metricRows" : {
        "metricRows" : {
          "issue" : "String value",
          "XValue" : "String value",
          "YLabels" : {
            "YLabels" : "String value"
          },
          "YValues" : {
            "YValues" : 15
          }
        }
      },
      "resourceName" : "String value",
      "XValueProperty" : {
        "label" : "String value",
        "unit" : "NUMBER"
      },
      "YValueProperty" : {
        "YValueProperty" : {
          "label" : "String value",
          "maxVal" : 4,
          "minVal" : 4,
          "unit" : "NUMBER"
        }
      }
    }
  }
}