Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET HistoricalRFStats

Represents statistics for radio interfaces of lightweight wireless access points collected 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 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/HistoricalRFStats

Deprecated

This version has been deprecated due to poor performance in large-scale environments. Please use v4/data/HistoricalRFStats and v4/data/HistoricalRFLoadStats.

Response Parameters

Attribute Description

channelNumber ChannelNumberEnum

Channel number that the radio is operating on

  • UNKNOWN
  • _1
  • _2
  • _3
  • _4
  • _5
  • _6
  • _7
  • _8
  • _9
  • _10
  • _11
  • _12
  • _13
  • _14
  • _17
  • _20
  • _21
  • _22
  • _23
  • _24
  • _25
  • _26
  • _29
  • _33
  • _34
  • _36
  • _37
  • _38
  • _40
  • _41
  • _42
  • _44
  • _45
  • _46
  • _48
  • _49
  • _52
  • _53
  • _56
  • _57
  • _60
  • _61
  • _64
  • _65
  • _69
  • _73
  • _77
  • _81
  • _85
  • _89
  • _93
  • _97
  • _100
  • _101
  • _104
  • _105
  • _108
  • _109
  • _112
  • _113
  • _116
  • _117
  • _120
  • _121
  • _124
  • _125
  • _128
  • _129
  • _132
  • _133
  • _136
  • _137
  • _140
  • _141
  • _144
  • _145
  • _149
  • _153
  • _157
  • _161
  • _165
  • _169
  • _173
  • _177
  • _181
  • _185
  • _189
  • _193
  • _197
  • _201
  • _205
  • _209
  • _213
  • _217
  • _221
  • _225
  • _229
  • _233

channelUtilization int

Channel Utilization (%)

clientCount int

Number of associated clients

collectionTime String

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

coverageProfile RFProfileEnum

  • FAILED
  • PASSED

ethernetMac String

MAC address of the ethernet interface on the AP

interferenceProfile RFProfileEnum

Interference profile

  • FAILED
  • PASSED

loadProfile RFProfileEnum

Load profile

  • FAILED
  • PASSED

macAddress String

Base radio MAC address

noiseProfile RFProfileEnum

Noise profile

  • FAILED
  • PASSED

operStatus RadioOperStatusEnum

Operational Status

  • DOWN
  • UP
  • NOTASSOCIATED
  • UNKNOWN

poorCoverageClients int

Poor coverage clients

powerLevel int

Power level of the radio

rxUtilization int

Rx Utilization (%)

slotId String

Slot ID of the radio

txUtilization int

Tx Utilization (%)

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://localhost/webacs/api/v1/data/HistoricalRFStats/15

<?xml version="1.0" ?>
<queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/HistoricalRFStats/15" rootUrl="https://localhost/webacs/api/v1/data">
  <entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://localhost/webacs/api/v1/data/HistoricalRFStats/15">
    <historicalRFStatsDTO displayName="String value" id="15" uuid="String value">
      <channelNumber>UNKNOWN</channelNumber>
      <clientCount>1</clientCount>
      <coverageProfile>FAILED</coverageProfile>
      <interferenceProfile>FAILED</interferenceProfile>
      <loadProfile>FAILED</loadProfile>
      <noiseProfile>FAILED</noiseProfile>
      <operStatus>DOWN</operStatus>
      <powerLevel>1</powerLevel>
      <channelUtilization>1</channelUtilization>
      <collectionTime>String value</collectionTime>
      <ethernetMac>String value</ethernetMac>
      <macAddress>String value</macAddress>
      <poorCoverageClients>1</poorCoverageClients>
      <rxUtilization>1</rxUtilization>
      <slotId>String value</slotId>
      <txUtilization>1</txUtilization>
    </historicalRFStatsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v1/data/HistoricalRFStats/15.json

{
  "queryResponse" : {
    "@type" : "HistoricalRFStats",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/HistoricalRFStats\/15",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "historicalRFStatsDTO",
      "@type" : "HistoricalRFStats",
      "@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/HistoricalRFStats\/15",
      "historicalRFStatsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "channelNumber" : "UNKNOWN",
        "clientCount" : 1,
        "coverageProfile" : "FAILED",
        "interferenceProfile" : "FAILED",
        "loadProfile" : "FAILED",
        "noiseProfile" : "FAILED",
        "operStatus" : "DOWN",
        "powerLevel" : 1,
        "channelUtilization" : 1,
        "collectionTime" : "String value",
        "ethernetMac" : "String value",
        "macAddress" : "String value",
        "poorCoverageClients" : 1,
        "rxUtilization" : 1,
        "slotId" : "String value",
        "txUtilization" : 1
      }
    }
  }
}