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

GET statisticsService/sensors/metrics

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Fetches all sensors for a specific device, as well as the URL of the next step (“Device Sensors Metric Data”) that is available under the "url" element.
Examples:
op/statisticsService/sensors/metrics?device=10.56.23.63
op/statisticsService/sensors/metrics?device=10.56.23.63&sensorType=Watts
Valid sensor types:
Other, Unknown, VoltsAC, VoltsDC, milliAmps, Watts, Hertz, Celsius, PercentRH, Rpm, Cmm, Truthvalue, SpecialEnum, DBm

Since Product Version: 2.0

Resource URL

/webacs/api/v1/op/statisticsService/sensors/metrics

Request Parameters

Type Attribute Name Source Description

String

device required

query

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

String

sensorType optional

query

The sensor type

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. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided

Long

startTime optional

query

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

Long

endTime optional

query

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

Response Parameters

Type Attribute Name Description

String

info

Metrics info

MetricDetailsDTO[]

metrics

Metric details list

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

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <metricsDTO>
    <info>String value</info>
    <metrics>
      <metrics>
        <description>String value</description>
        <name>String value</name>
        <type>TIME_SERIES</type>
        <units>
          <units>NUMBER</units>
        </units>
        <url>String value</url>
      </metrics>
    </metrics>
  </metricsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/statisticsService/sensors/metrics.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/sensors\/metrics",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "metricsDTO" : {
      "info" : "String value",
      "metrics" : {
        "metrics" : {
          "description" : "String value",
          "name" : "String value",
          "type" : "TIME_SERIES",
          "units" : {
            "units" : "NUMBER"
          },
          "url" : "String value"
        }
      }
    }
  }
}