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

GET statisticsService/interfaces/metrics/{metric}

Fetches the metric data for an Interface

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/v4/op/statisticsService/interfaces/metrics/{metric}

Unmodified

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

Request Parameters

Attribute Source Description

metric String

path

Required

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

device String

query

Required

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

ifName String

query

Required

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

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

endTime Long

query

Optional

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

isFullHierarchy Boolean

query

Optional

Specifies full or short class hierarchy which is needed. Used in QOS Class Map and QOS Class Map Top Trend metrics. Default is false.

direction Integer

query

Optional

Direction (1 - input, 2 - output). Used in QOS Class Map Top Trend metric. Default is 2.

qosRateField String

query

Optional

One of dropPolicyToggle, prePolicyToggle, postPolicyToggle. Used in QOS Class Map Top Trend metric. Default is dropPolicyToggle.

trafficDirection String

query

Optional

One of ALL, IN, OUT. Used in Top N Application and Top Application Traffic Overtime metrics. Default is ALL.

sortOrder String

query

Optional

One of DESC, ASC. Used in Top N Application and Top Application Traffic Overtime metrics. Default is DESC.

networkAwareType String

query

Optional

Network aware. Wireless: 1, Wired: 2, All: -1. Used in Top N Application and Top Application Traffic Overtime metrics. Default is -1.

appId String

query

Optional

Comma separated application IDs. Used in Top N Application and Top Application Traffic Overtime metrics. Default is 0 (all applications).

siteId String

query

Optional

Site ID. Used in Top N Application and Top Application Traffic Overtime metrics. Default is 0 (all sites).

dataType String

query

Optional

One of rate, volume. Used in Top N Application and Top Application Traffic Overtime metrics. Default is rate.

dscp String

query

Optional

DSCP. Used in Top N Application metric.

metricDataType String

query

Optional

One of TOP_N, TIME_SERIES. Current metric's default data type is used if this parameter is not set.

firstResult Integer

header

Optional

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

maxResults Integer

header

Optional

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

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://10.64.80.159/webacs/api/v4/op/statisticsService/interfaces/metrics/{metric}?device=192.168.0.1&ifName=GigabitEthernet0/1&timeInterval=1

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.80.159/webacs/api/v4/op/statisticsService/interfaces/metrics/{metric}?device=192.168.0.1&amp;amp;ifName=GigabitEthernet0/1&amp;amp;timeInterval=1
					" rootUrl="https://10.64.80.159/webacs/api/v4/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://10.64.80.159/webacs/api/v4/op/statisticsService/interfaces/metrics/{metric}.json?device=192.168.0.1&ifName=GigabitEthernet0/1&timeInterval=1

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.64.80.159/webacs/api/v4/op/statisticsService/interfaces/metrics/{metric}?device=192.168.0.1&amp;ifName=GigabitEthernet0/1&amp;timeInterval=1\n\t\t\t\t\t",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.80.159/webacs/api/v4/op",
    "metricData" : [ {
      "XValueProperty" : {
        "label" : "String value",
        "unit" : "NUMBER"
      },
      "YValueProperty" : {
        "yvalueProperty" : [ {
          "label" : "String value",
          "maxVal" : 4.0,
          "minVal" : 4.0,
          "unit" : "NUMBER"
        }, {
          "label" : "Another string value",
          "maxVal" : 14.0,
          "minVal" : 14.0,
          "unit" : "STRING"
        } ]
      },
      "currentDateTime" : "String value",
      "description" : "String value",
      "metricName" : "String value",
      "metricRows" : {
        "metricRows" : [ {
          "XValue" : "String value",
          "YLabels" : {
            "ylabels" : [ "String value", "Another string value" ]
          },
          "YValues" : {
            "yvalues" : [ 15.0, 25.0 ]
          },
          "issue" : "String value"
        }, {
          "XValue" : "Another string value",
          "YLabels" : {
            "ylabels" : [ "String value", "Another string value" ]
          },
          "YValues" : {
            "yvalues" : [ 15.0, 25.0 ]
          },
          "issue" : "Another string value"
        } ]
      },
      "resourceName" : "String value"
    } ]
  }
}