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

GET statisticsService/interfacecrc/metrics/{metric}

Fetches performance data of a given metric or metrics for a specific interface over a given period.
Examples:
op/statisticsService/interfacecrc/metrics/crcErrorsCount?startTime=1499153553628& endTime=1499157153628&metricDataType=TIME_SERIES&device=10.56.23.63& ifName=BDI519

op/statisticsService/interfacecrc/metrics/stats?metrics=crcErrorsCount& startTime=1499153553628&endTime=1499157153628&metricDataType=STATS& device=10.56.23.63&ifName=BDI519

OR TOP N performance data of a given metric for all interfaces over a given time period.
Example: op/statisticsService/interfacecrc/metrics/crcErrorsPercentage?startTime=1499153553628& endTime=1499157153628&metricDataType=TOP_N

Since Product Version: 2.0

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

/webacs/api/v1/op/statisticsService/interfacecrc/metrics/{metric}

Request Parameters

Attribute Source Description

metric String

path

Required

The name of the metric for which the data needs to be fetched

device String

query

Required

The IP address of the device to which the optical SFP transceiver belongs.

ifName String

query

Required

The name of the interface to which the optical SFP transceivers belongs.

interfaceId Integer

query

Optional

timeInterval Integer

query

Optional

Specifies the range of time (in hours). This field can contain values like 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. By default is 1 hour if neither timeInterval parameter nor the parameters startTime and endTime not provided.

startTime Long

query

Optional

Specifies the start time in milliseconds. The timeInterval parameter overrides this parameter.

endTime Long

query

Optional

Specifies the end time in milliseconds. The timeInterval parameter overrides this parameter.

firstResult Integer

query

Optional

Defines the offset from the first result you want to fetch. Default is 0.

maxResults Integer

query

Optional

Defines maximum amount of hits to be returned. Default is 20.

sort String

query

Optional

Defines a comma-separated list of attribute names with their respective order.

metricDataType String

query

Optional

Determines the query type to retirieve the KPI. Valid values are TOP_N or TIME_SERIES

portGroup String

query

Optional

deviceGroup String

query

Optional

Response Parameters

Attribute Description

currentDateTime String

Current timestamp

description String

Metric description

metricName String

Metric name

metricRows Arrow image MetricRowDTO[]

Metric data list

resourceName String

Resource name

xValueProperty Arrow image XValueProperty

Properties of X values

yValueProperty Arrow image 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.20.127.108/webacs/api/v1/op/statisticsService/interfacecrc/metrics/{metric}

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v1/op/statisticsService/interfacecrc/metrics/{metric}" rootUrl="https://172.20.127.108/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>Another string value</YLabels>
        </YLabels>
        <YValues>
          <YValues>15.0</YValues>
          <YValues>25.0</YValues>
        </YValues>
      </metricRows>
      <metricRows>
        <issue>Another string value</issue>
        <XValue>Another string value</XValue>
        <YLabels>
          <YLabels>String value</YLabels>
          <YLabels>Another string value</YLabels>
        </YLabels>
        <YValues>
          <YValues>15.0</YValues>
          <YValues>25.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>
        <label>Another string value</label>
        <maxVal>14.0</maxVal>
        <minVal>14.0</minVal>
        <unit>STRING</unit>
      </YValueProperty>
    </YValueProperty>
  </metricData>
</mgmtResponse>

Sample JSON Response Payload

https://172.20.127.108/webacs/api/v1/op/statisticsService/interfacecrc/metrics/{metric}.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/op\/statisticsService\/interfacecrc\/metrics\/{
      metric
    }",
    "@rootUrl" : "https : \/\/172.20.127.108\/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",
            "Another string value"]
          },
          "YValues" : {
            "YValues" : [15,
            25]
          }
        },
        {
          "issue" : "Another string value",
          "XValue" : "Another string value",
          "YLabels" : {
            "YLabels" : ["String value",
            "Another string value"]
          },
          "YValues" : {
            "YValues" : [15,
            25]
          }
        }]
      },
      "resourceName" : "String value",
      "XValueProperty" : {
        "label" : "String value",
        "unit" : "NUMBER"
      },
      "YValueProperty" : {
        "YValueProperty" : [{
          "label" : "String value",
          "maxVal" : 4,
          "minVal" : 4,
          "unit" : "NUMBER"
        },
        {
          "label" : "Another string value",
          "maxVal" : 14,
          "minVal" : 14,
          "unit" : "STRING"
        }]
      }
    }
  }
}