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

GET statisticsService/opticalotn/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 the metric data for an Interface
Example: op/statisticsService/opticalotn/metrics/{metrics}?

TIME SERIES performance data of a given metric for all probes over a given time period.
Example: op/statisticsService/opticalotn/metrics/Voltage,RxPower,Temperature?startTime=1498986621324& endTime=1498990221324&ifName=TIME_SERIES&device=10.56.23.109& pmInterval=1-DAY

Since Product Version: 2.0

Resource URL

/webacs/api/v2/op/statisticsService/opticalotn/metrics/{metric}

Request Parameters

Type Attribute Name Source Description

String

device required

query

The IP address of the device to which the interface belongs.

String

ifName required

query

Name of the interface for which the metric data need to be fetched.

String

metric required

path

The metric name for which the data need to be fetched.

String

pmInterval optional

query

pmInterval 15-MIN or 1-DAY

String

location optional

query

location NEND or FEND

Integer

timeInterval optional

query

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.

Long

startTime optional

query

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

Long

endTime optional

query

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

Integer

firstResult optional

query

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

Integer

maxResults optional

query

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

String

sort optional

query

Comma-separated list of attribute names with their respective order.

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/v2/op/statisticsService/opticalotn/metrics/{metric}

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

{
  "mgmtResponse" : {
    "@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/opticalotn/metrics/{metric}",
    "@responseType" : "operation",
    "@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.0 ]
          }
        } ]
      },
      "resourceName" : "String value",
      "xvalueProperty" : {
        "label" : "String value",
        "unit" : "NUMBER"
      },
      "yvalueProperty" : {
        "yvalueProperty" : [ {
          "label" : "String value",
          "maxVal" : 4.0,
          "minVal" : 4.0,
          "unit" : "NUMBER"
        } ]
      }
    } ]
  }
}