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

GET statisticsService/circuits/metrics

Fetches all the counters that are relevant for the circuit type, the counter type, and the url of the next step (Circuit Metric Data) that is available under the "url" element. Example: /op/statisticsService/circuits/metrics?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

Unmodified

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

Request Parameters

Attribute Source Description

circuitType String

query

Required

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

circuitId String

query

Required

Id of the circuit.

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://10.64.80.159/webacs/api/v4/op/statisticsService/circuits/metrics

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v4/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>STATS</type>
        <units>
          <units>NUMBER</units>
          <units>STRING</units>
        </units>
        <url>Another string value</url>
      </metrics>
    </metrics>
  </metricsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.80.159/webacs/api/v4/op/statisticsService/circuits/metrics.json

{
  "mgmtResponse" : {
    "@requestUrl" : "../../../../../../pages/common/login.jsp.html",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.80.159/webacs/api/v4/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" : "STATS",
          "units" : {
            "units" : [ "NUMBER", "STRING" ]
          },
          "url" : "Another string value"
        } ]
      }
    } ]
  }
}