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

GET statisticsService/sensors/metrics/{metric}

Fetches up to date sensors performance data for a specific device.
Example:
op/statisticsService/sensors/metrics/sensorValue?metricDataType=TOP_N&device=10.56.23.63

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/sensors/metrics/{metric}

Request Parameters

Attribute Source Description

metric String

path

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

device String

query

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

sensorName String

query

OptionalThe name of the sensor.

sensorType String

query

OptionalThe sensor type

timeInterval Integer

query

OptionalSpecifies 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

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

endTime Long

query

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

firstResult Integer

query

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

maxResults Integer

query

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

sort String

query

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

metricDataType String

query

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

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.25.123.114/webacs/api/v1/op/statisticsService/sensors/metrics/{metric}

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsService/sensors/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/statisticsService/sensors/metrics/{metric}.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/sensors\/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"
        }
      }
    }
  }
}