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

GET HistoricalRFCounters

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

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

Resource URL

/webacs/api/v1/data/HistoricalRFCounters

Response Parameters

Type Attribute Name Description

long

ackFailureCount

ACK failure count

String

collectionTime

The time collection of this record was finished, measured in milliseconds since the Unix epoch.

long

failedCount

Failed count

long

fcsErrorCount

FCS error count

long

frameDuplicateCount

Frame duplicate count

String

instanceUuid

This is a uuid for this instance.

String

macAddress

Base radio MAC address

long

multipleRetryCount

Multiple retry count

long

retryCount

Retry count

long

rtsFailureCount

RTS failure count

long

rtsSuccessCount

RTS success count

long

rxFragmentCount

Rx fragment count

long

rxMulticastFrameCount

Rx multicast frame count

String

slotId

Radio slot ID

long

txFragmentCount

Tx fragment count

long

txFrameCount

Tx frame count

long

txMulticastFrameCount

Tx multicast frame count

long

wepUndecryptableCount

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://172.25.123.114/webacs/api/v1/data/HistoricalRFCounters/15

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

Sample JSON Payload

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

{
  "queryResponse" : {
    "@type" : "HistoricalRFCounters",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/HistoricalRFCounters\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "historicalRFCountersDTO",
      "@type" : "HistoricalRFCounters",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/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
      }
    }
  }
}