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

GET statisticsService/y1731bins/metrics

Fetches all metrics that are relevant for a specific probe, as well as the URL of the next step ("Y1731 Bins performance Data") that is available under the "url" element. Available metrics are: Delay (forward, backward, two way), Jitter (forward, backward, two way)
Example: op/statisticsService/y1731bins/metrics?device=10.56.23.64& sourceMpid=MPID%20134&targetMpid=MPID%20135&cfmDomain=level5&bridgeId=995& ipslaServiceName=level5&operationType=Delay

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

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

/webacs/api/v1/op/statisticsService/y1731bins/metrics

Request Parameters

Attribute Source Description

device String

query

Optional

Device IP or name of the source MEP

sourceMpid String

query

Optional

ID of source MEP

targetMpid String

query

Optional

ID of destination MEP

cfmDomain String

query

Optional

evc String

query

Optional

bridgeId Integer

query

Optional

serviceName String

query

Optional

operationType String

query

Optional

Valid options are Loss or Delay

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

endTime Long

query

Optional

Specifies the end time in milli 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://10.56.58.149/webacs/api/v1/op/statisticsService/y1731bins/metrics

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

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