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

# GET HistoricalRFCounters

Represents 802.11 counters collected for radio interfaces of lightweight wireless access points in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying it, it is better to use paged query or filtered by AP or time.

Since Product Version: 1.2

- Jump To

- v1
- v2
- v3
- v4

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
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/data/HistoricalRFCounters

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
ackFailureCount long | ACK failure count
collectionTime String | The time collection of this record was finished, measured in milliseconds since the Unix epoch.
failedCount long | Failed count
fcsErrorCount long | FCS error count
frameDuplicateCount long | Frame duplicate count
macAddress String | Base radio MAC address
multipleRetryCount long | Multiple retry count
retryCount long | Retry count
rtsFailureCount long | RTS failure count
rtsSuccessCount long | RTS success count
rxFragmentCount long | Rx fragment count
rxMulticastFrameCount long | Rx multicast frame count
slotId String | Radio slot ID
txFragmentCount long | Tx fragment count
txFrameCount long | Tx frame count
txMulticastFrameCount long | Tx multicast frame count
wepUndecryptableCount long | WEP undecryptable count

## 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 Payload

https://10.64.88.203/webacs/api/v1/data/HistoricalRFCounters/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFCounters" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/HistoricalRFCounters/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="historicalRFCountersDTO" type="HistoricalRFCounters" url="https://10.64.88.203/webacs/api/v1/data/HistoricalRFCounters/15">
        <historicalRFCountersDTO displayName="String value" id="15" uuid="String value">
          <ackFailureCount>2</ackFailureCount>
          <failedCount>2</failedCount>
          <fcsErrorCount>2</fcsErrorCount>
          <frameDuplicateCount>2</frameDuplicateCount>
          <multipleRetryCount>2</multipleRetryCount>
          <retryCount>2</retryCount>
          <rtsFailureCount>2</rtsFailureCount>
          <rtsSuccessCount>2</rtsSuccessCount>
          <rxFragmentCount>2</rxFragmentCount>
          <rxMulticastFrameCount>2</rxMulticastFrameCount>
          <txFragmentCount>2</txFragmentCount>
          <txFrameCount>2</txFrameCount>
          <txMulticastFrameCount>2</txMulticastFrameCount>
          <wepUndecryptableCount>2</wepUndecryptableCount>
          <collectionTime>String value</collectionTime>
          <macAddress>String value</macAddress>
          <slotId>String value</slotId>
        </historicalRFCountersDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v1/data/HistoricalRFCounters/15.json

    {
      "queryResponse" : {
        "@type" : "HistoricalRFCounters",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/HistoricalRFCounters/15",
        "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
        "entity" : {
          "@dtoType" : "historicalRFCountersDTO",
          "@type" : "HistoricalRFCounters",
          "@url" : "https : //10.64.88.203/webacs/api/v1/data/HistoricalRFCounters/15",
          "historicalRFCountersDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "ackFailureCount" : 2,
            "failedCount" : 2,
            "fcsErrorCount" : 2,
            "frameDuplicateCount" : 2,
            "multipleRetryCount" : 2,
            "retryCount" : 2,
            "rtsFailureCount" : 2,
            "rtsSuccessCount" : 2,
            "rxFragmentCount" : 2,
            "rxMulticastFrameCount" : 2,
            "txFragmentCount" : 2,
            "txFrameCount" : 2,
            "txMulticastFrameCount" : 2,
            "wepUndecryptableCount" : 2,
            "collectionTime" : "String value",
            "macAddress" : "String value",
            "slotId" : "String value"
          }
        }
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v2/data/HistoricalRFCounters

Unmodified

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

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
ackFailureCount long | ACK failure count
collectionTime String | The time collection of this record was finished, measured in milliseconds since the Unix epoch.
failedCount long | Failed count
fcsErrorCount long | FCS error count
frameDuplicateCount long | Frame duplicate count
macAddress String | Base radio MAC address
multipleRetryCount long | Multiple retry count
retryCount long | Retry count
rtsFailureCount long | RTS failure count
rtsSuccessCount long | RTS success count
rxFragmentCount long | Rx fragment count
rxMulticastFrameCount long | Rx multicast frame count
slotId String | Radio slot ID
txFragmentCount long | Tx fragment count
txFrameCount long | Tx frame count
txMulticastFrameCount long | Tx multicast frame count
wepUndecryptableCount long | WEP undecryptable count

## 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 Payload

https://10.64.88.203/webacs/api/v2/data/HistoricalRFCounters/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFCounters" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/HistoricalRFCounters/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="historicalRFCountersDTO" type="HistoricalRFCounters" url="https://10.64.88.203/webacs/api/v2/data/HistoricalRFCounters/15">
        <historicalRFCountersDTO displayName="String value" id="15" uuid="String value">
          <ackFailureCount>2</ackFailureCount>
          <failedCount>2</failedCount>
          <fcsErrorCount>2</fcsErrorCount>
          <frameDuplicateCount>2</frameDuplicateCount>
          <multipleRetryCount>2</multipleRetryCount>
          <retryCount>2</retryCount>
          <rtsFailureCount>2</rtsFailureCount>
          <rtsSuccessCount>2</rtsSuccessCount>
          <rxFragmentCount>2</rxFragmentCount>
          <rxMulticastFrameCount>2</rxMulticastFrameCount>
          <txFragmentCount>2</txFragmentCount>
          <txFrameCount>2</txFrameCount>
          <txMulticastFrameCount>2</txMulticastFrameCount>
          <wepUndecryptableCount>2</wepUndecryptableCount>
          <collectionTime>String value</collectionTime>
          <macAddress>String value</macAddress>
          <slotId>String value</slotId>
        </historicalRFCountersDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v2/data/HistoricalRFCounters/15.json

    {
      "queryResponse" : {
        "@type" : "HistoricalRFCounters",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v2/data/HistoricalRFCounters/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "historicalRFCountersDTO",
          "@type" : "HistoricalRFCounters",
          "@url" : "https://10.64.88.203/webacs/api/v2/data/HistoricalRFCounters/15",
          "historicalRFCountersDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "ackFailureCount" : 2,
            "collectionTime" : "String value",
            "failedCount" : 2,
            "fcsErrorCount" : 2,
            "frameDuplicateCount" : 2,
            "macAddress" : "String value",
            "multipleRetryCount" : 2,
            "retryCount" : 2,
            "rtsFailureCount" : 2,
            "rtsSuccessCount" : 2,
            "rxFragmentCount" : 2,
            "rxMulticastFrameCount" : 2,
            "slotId" : "String value",
            "txFragmentCount" : 2,
            "txFrameCount" : 2,
            "txMulticastFrameCount" : 2,
            "wepUndecryptableCount" : 2
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v3/data/HistoricalRFCounters

Unmodified

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

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
ackFailureCount long | ACK failure count
collectionTime String | The time collection of this record was finished, measured in milliseconds since the Unix epoch.
failedCount long | Failed count
fcsErrorCount long | FCS error count
frameDuplicateCount long | Frame duplicate count
macAddress String | Base radio MAC address
multipleRetryCount long | Multiple retry count
retryCount long | Retry count
rtsFailureCount long | RTS failure count
rtsSuccessCount long | RTS success count
rxFragmentCount long | Rx fragment count
rxMulticastFrameCount long | Rx multicast frame count
slotId String | Radio slot ID
txFragmentCount long | Tx fragment count
txFrameCount long | Tx frame count
txMulticastFrameCount long | Tx multicast frame count
wepUndecryptableCount long | WEP undecryptable count

## 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 Payload

https://10.64.88.203/webacs/api/v3/data/HistoricalRFCounters/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFCounters" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/HistoricalRFCounters/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="historicalRFCountersDTO" type="HistoricalRFCounters" url="https://10.64.88.203/webacs/api/v3/data/HistoricalRFCounters/15">
        <historicalRFCountersDTO displayName="String value" id="15" uuid="String value">
          <ackFailureCount>2</ackFailureCount>
          <failedCount>2</failedCount>
          <fcsErrorCount>2</fcsErrorCount>
          <frameDuplicateCount>2</frameDuplicateCount>
          <multipleRetryCount>2</multipleRetryCount>
          <retryCount>2</retryCount>
          <rtsFailureCount>2</rtsFailureCount>
          <rtsSuccessCount>2</rtsSuccessCount>
          <rxFragmentCount>2</rxFragmentCount>
          <rxMulticastFrameCount>2</rxMulticastFrameCount>
          <txFragmentCount>2</txFragmentCount>
          <txFrameCount>2</txFrameCount>
          <txMulticastFrameCount>2</txMulticastFrameCount>
          <wepUndecryptableCount>2</wepUndecryptableCount>
          <collectionTime>String value</collectionTime>
          <macAddress>String value</macAddress>
          <slotId>String value</slotId>
        </historicalRFCountersDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v3/data/HistoricalRFCounters/15.json

    {
      "queryResponse" : {
        "@type" : "HistoricalRFCounters",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/HistoricalRFCounters/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "historicalRFCountersDTO",
          "@type" : "HistoricalRFCounters",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/HistoricalRFCounters/15",
          "historicalRFCountersDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "ackFailureCount" : 2,
            "collectionTime" : "String value",
            "failedCount" : 2,
            "fcsErrorCount" : 2,
            "frameDuplicateCount" : 2,
            "macAddress" : "String value",
            "multipleRetryCount" : 2,
            "retryCount" : 2,
            "rtsFailureCount" : 2,
            "rtsSuccessCount" : 2,
            "rxFragmentCount" : 2,
            "rxMulticastFrameCount" : 2,
            "slotId" : "String value",
            "txFragmentCount" : 2,
            "txFrameCount" : 2,
            "txMulticastFrameCount" : 2,
            "wepUndecryptableCount" : 2
          }
        } ]
      }
    }

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/HistoricalRFCounters

Updated

Since version 4 types of attributes macAddress, slotId and collectionTime have been changed.

## Response Parameters

Attribute | Description
--- | ---
ackFailureCount long | ACK failure count
collectionTime Date | The time collection of this record was finished. Note: The date has an incorrect UTC offset. Please see the FAQ for details.
failedCount long | Failed count
fcsErrorCount long | FCS error count
frameDuplicateCount long | Frame duplicate count
macAddress MacAddress | Base radio MAC address
multipleRetryCount long | Multiple retry count
retryCount long | Retry count
rtsFailureCount long | RTS failure count
rtsSuccessCount long | RTS success count
rxFragmentCount long | Rx fragment count
rxMulticastFrameCount long | Rx multicast frame count
slotId int | Radio slot ID
txFragmentCount long | Tx fragment count
txFrameCount long | Tx frame count
txMulticastFrameCount long | Tx multicast frame count
wepUndecryptableCount long | WEP undecryptable count

## 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 Payload

https://10.64.88.203/webacs/api/v4/data/HistoricalRFCounters/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFCounters" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/HistoricalRFCounters/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="historicalRFCountersDTO" type="HistoricalRFCounters" url="https://10.64.88.203/webacs/api/v4/data/HistoricalRFCounters/15">
        <historicalRFCountersDTO displayName="String value" id="15" uuid="String value">
          <ackFailureCount>2</ackFailureCount>
          <failedCount>2</failedCount>
          <fcsErrorCount>2</fcsErrorCount>
          <frameDuplicateCount>2</frameDuplicateCount>
          <multipleRetryCount>2</multipleRetryCount>
          <retryCount>2</retryCount>
          <rtsFailureCount>2</rtsFailureCount>
          <rtsSuccessCount>2</rtsSuccessCount>
          <rxFragmentCount>2</rxFragmentCount>
          <rxMulticastFrameCount>2</rxMulticastFrameCount>
          <txFragmentCount>2</txFragmentCount>
          <txFrameCount>2</txFrameCount>
          <txMulticastFrameCount>2</txMulticastFrameCount>
          <wepUndecryptableCount>2</wepUndecryptableCount>
          <collectionTime>1986-07-24T00:00:00+05:30</collectionTime>
          <macAddress>
            <octets>000a959d6816</octets>
          </macAddress>
          <slotId>1</slotId>
        </historicalRFCountersDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/HistoricalRFCounters/15.json

    {
      "queryResponse" : {
        "@type" : "HistoricalRFCounters",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/HistoricalRFCounters/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "historicalRFCountersDTO",
          "@type" : "HistoricalRFCounters",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/HistoricalRFCounters/15",
          "historicalRFCountersDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "ackFailureCount" : 2,
            "collectionTime" : "1986-07-23T18:30:00.000Z",
            "failedCount" : 2,
            "fcsErrorCount" : 2,
            "frameDuplicateCount" : 2,
            "macAddress" : {
              "octets" : "000a959d6816"
            },
            "multipleRetryCount" : 2,
            "retryCount" : 2,
            "rtsFailureCount" : 2,
            "rtsSuccessCount" : 2,
            "rxFragmentCount" : 2,
            "rxMulticastFrameCount" : 2,
            "slotId" : 1,
            "txFragmentCount" : 2,
            "txFrameCount" : 2,
            "txMulticastFrameCount" : 2,
            "wepUndecryptableCount" : 2
          }
        } ]
      }
    }