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

GET statisticsService/bngSessions/metrics

Fetches all metrics that are relevant for the session, as well as the URL of the next step ("BNG IP Pool Metric Data") that is available under the "url" element.
Example: op/statisticsService/bngSessions/metrics?device=10.56.23.51&pointType=physical &sessionType=all

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/bngSessions/metrics

Unmodified

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

Request Parameters

Attribute Source Description

device String

query

Required

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

cardName String

query

Required

Defines the card name on which the statistics will be fetched

sessionType String

query

Required

Subscriber session type

pointType String

query

Required

Subscriber point type

timeInterval Integer

query

Optional

Fetches the data for the last specified number of hours. Applicable values are 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. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided.

startTime Long

query

Optional

Specifies the start time in milliseconds. The timeInterval parameter overrides this parameter.

endTime Long

query

Optional

Specifies the end time in milliseconds. 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.64.80.159/webacs/api/v4/op/statisticsService/bngSessions/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/bngSessions/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"
        } ]
      }
    } ]
  }
}