Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET statisticsService/devices/metrics

Fetches the URLs for various metrics of the device.

Since Product Version: 3.1

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

Resource URL

/webacs/api/v3/op/statisticsService/devices/metrics

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

device String

query

RequiredThe device IP or name for which the data need to be fetched.

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 seconds. The timeInterval parameter overrides this parameter.

endTime Long

query

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

Response Parameters

Attribute Description

info String

Metrics info

metrics Arrow image MetricDetailsDTO[]

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://localhost/webacs/api/v3/op/statisticsService/devices/metrics?device=172.20.151.111&timeInterval=4

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/statisticsService/devices/metrics?device=172.20.151.111&amp;amp;timeInterval=4" rootUrl="https://localhost/webacs/api/v3/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>STRING</units>
        </units>
        <url>String value</url>
      </metrics>
      <metrics>
        <description>Another string value</description>
        <name>Another string value</name>
        <type>TOP_N</type>
        <units>
          <units>NUMBER</units>
          <units>STRING</units>
        </units>
        <url>Another string value</url>
      </metrics>
    </metrics>
  </metricsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v3/op/statisticsService/devices/metrics.json?device=172.20.151.111&timeInterval=4

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v3/op/statisticsService/devices/metrics?device=172.20.151.111&amp;timeInterval=4",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v3/op",
    "metricsDTO" : [ {
      "info" : "String value",
      "metrics" : {
        "metrics" : [ {
          "description" : "String value",
          "name" : "String value",
          "type" : "TIME_SERIES",
          "units" : {
            "units" : [ "NUMBER", "STRING" ]
          },
          "url" : "String value"
        }, {
          "description" : "Another string value",
          "name" : "Another string value",
          "type" : "TOP_N",
          "units" : {
            "units" : [ "NUMBER", "STRING" ]
          },
          "url" : "Another string value"
        } ]
      }
    } ]
  }
}