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

# GET statisticsService/opticalSfp/metrics

Fetches all metrics that are relevant for the SFP module, as well as the URL of the next step ("Optical SFP Metric Data") that is available under the "url" element. Example: op/statisticsService/opticalSfp/metrics?device=10.56.23.27&ifName=GigabitEthernet0/6

Since Product Version: 2.0

- Jump To

- v1
- v2
- v3
- v4

### 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/opticalSfp/metrics

## Request Parameters

Attribute | Source | Description
--- | --- | ---
device String | query | Required The IP address of the device to which the optical SFP transceiver belongs.
ifName String | query | Required The name of the interface to which the optical SFP transceivers belongs.
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. 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 MetricDetailsDTO[] | Metric details list
Attribute | Description
--- | ---
description String | Metric description
name String | Metric name
type MetricTypeEnum | Allowed values TIME_SERIES STATS TOP_N TABLE UID
units MetricUnitEnum[] | Units used in metric Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND
url String | URL to fetch metric data

## 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://172.20.127.108/webacs/api/v1/op/statisticsService/opticalSfp/metrics

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v1/op/statisticsService/opticalSfp/metrics.json

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

### 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/v2/op/statisticsService/opticalSfp/metrics

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
device String | query | Required The IP address of the device to which the optical SFP transceiver belongs.
ifName String | query | Required The name of the interface to which the optical SFP transceivers belongs.
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. 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 MetricDetailsDTO[] | Metric details list
Attribute | Description
--- | ---
description String | Metric description
name String | Metric name
type MetricTypeEnum | Allowed values TIME_SERIES STATS TOP_N TABLE UID
units MetricUnitEnum[] | Units used in metric Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND
url String | URL to fetch metric data

## 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://172.20.127.108/webacs/api/v2/op/statisticsService/opticalSfp/metrics

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v2/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://172.20.127.108/webacs/api/v2/op/statisticsService/opticalSfp/metrics.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/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"
            } ]
          }
        } ]
      }
    }

### 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/v3/op/statisticsService/opticalSfp/metrics

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
device String | query | Required The IP address of the device to which the optical SFP transceiver belongs.
ifName String | query | Required The name of the interface to which the optical SFP transceivers belongs.
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. 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 MetricDetailsDTO[] | Metric details list
Attribute | Description
--- | ---
description String | Metric description
name String | Metric name
type MetricTypeEnum | Allowed values TIME_SERIES STATS TOP_N TABLE UID
units MetricUnitEnum[] | Units used in metric Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND
url String | URL to fetch metric data

## 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://172.20.127.108/webacs/api/v3/op/statisticsService/opticalSfp/metrics

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/webacs/api/v3/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://172.20.127.108/webacs/api/v3/op/statisticsService/opticalSfp/metrics.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v3/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"
            } ]
          }
        } ]
      }
    }

### 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/opticalSfp/metrics

Unmodified

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

## Request Parameters

Attribute | Source | Description
--- | --- | ---
device String | query | Required The IP address of the device to which the optical SFP transceiver belongs.
ifName String | query | Required The name of the interface to which the optical SFP transceivers belongs.
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. 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 MetricDetailsDTO[] | Metric details list
Attribute | Description
--- | ---
description String | Metric description
name String | Metric name
type MetricTypeEnum | Allowed values TIME_SERIES STATS TOP_N TABLE UID
units MetricUnitEnum[] | Units used in metric Allowed values NUMBER STRING PERCENTAGE SECOND MILLISECOND BYTE KB MB BITS_PER_SECOND BYTES_PER_SECOND PACKETS FRAMES_PER_SECOND KB_PER_SEC HERTZ MEGAHERTZ DISC_UNIT NETWORK_UNIT DBM VOLT MICROSECOND MILLIAMP CELSIUS DECIBEL KBITS_PER_SEC BUFFER_UNDER_RUN_TIMES FAILURE_COUNT PS PS2 RAD_PER_SECOND DB RATIO ERROR_SECONDS CODE_VIOLATIONS BLOCK_ERRORS UNCORRECTABLE_WORDS BIT_ERRORS BLOCKS MA ERRORS BIT_ERRORS_RATE BIT BUFFER_OVERRUN_TIMES N_A PACKETS_PER_SECOND
url String | URL to fetch metric data

## 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://172.20.127.108/webacs/api/v4/op/statisticsService/opticalSfp/metrics

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v4/op/statisticsService/opticalSfp/metrics.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://172.20.127.108/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"
            } ]
          }
        } ]
      }
    }