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

GET statisticsService/circuits/metrics/{metric}

Fetches performance data of a given circuit and counter name. Example: /op/statisticsService/circuits/metrics/Ipslay1731AvgAvailability?maxResults=24&timeInterval=6&circuitType=EVC&circuitId=16229216

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

Resource URL

/webacs/api/v4/op/statisticsService/circuits/metrics/{metric}

Unmodified

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

Request Parameters

Attribute Source Description

metric String

path

Required

Metric name, e.g. Loss or OPT_MAX.

circuitId String

query

Required

Id of the circuit.

circuitType String

query

Required

Type of the circuit, E.g. OCHCC or EVC.

timeInterval Double

query

Optional

Time interval of the performance data (in hours), Default is set to 6 hours.

maxResults Long

query

Optional

Maximum number of results to display, Default is to show all results.

location String

query

Optional

Indicates if the endpoint is NEND or FEND (Relevant only to optical circuits)

deviceId String

query

Optional

Id of the device (Relevant only to optical circuits), E.g. 566622_10.58.234.67.

endpointName String

query

Optional

Endpoint name (Relevant only to optical circuits), E.g. CHAN-4-6-2.

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.56.58.149/webacs/api/v4/op/statisticsService/circuits/metrics/{metric}

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v4/op/statisticsService/circuits/metrics/{metric}" rootUrl="https://10.56.58.149/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.56.58.149/webacs/api/v4/op/statisticsService/circuits/metrics/{metric}.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.56.58.149/webacs/api/v4/op/statisticsService/circuits/metrics/{metric}",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.56.58.149/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"
    } ]
  }
}