Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET_HistoricalRFStats

# GET HistoricalRFStats

- Jump To

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Response Formats | xml json
HTTP Methods | GET

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.

## Resource URL

/webacs/api/v1/data/HistoricalRFStats

Since : 1.2

## Response Parameters

Type | Attribute Name | Description
--- | --- | ---
ChannelNumberEnum | channelNumber | Channel number that the radio is operating on Allowed values: UNKNOWN _1 _2 _3 _4 _5 _6 _7 _8 _9 _10 _11 _12 _13 _14 _20 _21 _22 _23 _24 _25 _26 _34 _36 _38 _40 _42 _44 _46 _48 _52 _56 _60 _64 _100 _104 _108 _112 _116 _120 _124 _128 _132 _136 _140 _149 _153 _157 _161 _165 _169 _173
int | channelUtilization | Channel Utilization (%)
int | clientCount | Number of associated clients
String | collectionTime | unix binary time on the server when the collection was performed.
RFProfileEnum | coverageProfile | Allowed values: FAILED PASSED
RFProfileEnum | interferenceProfile | Interference profile Allowed values: FAILED PASSED
RFProfileEnum | loadProfile | Load profile Allowed values: FAILED PASSED
String | macAddress | Base radio MAC address
RFProfileEnum | noiseProfile | Noise profile Allowed values: FAILED PASSED
RadioOperStatusEnum | operStatus | Operational Status Allowed values: DOWN UP NOTASSOCIATED UNKNOWN
int | poorCoverageClients | Poor coverage clients
int | powerLevel | power level of the radio
int | rxUtilization | Rx Utilization (%)
String | slotId | Slot ID of the radio
int | txUtilization | Tx Utilization (%)

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://192.168.116.207/webacs/api/v1/data/HistoricalRFStats/42

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/HistoricalRFStats/42" responseType="getEntity">
        <entity url="/webacs/data/className/15" type="className" dtoType="historicalRFStatsDTO_$$_javassist_5981">
            <historicalRFStatsDTO id="15" displayName="String value">
                <channelNumber>UNKNOWN</channelNumber>
                <channelUtilization>1</channelUtilization>
                <clientCount>1</clientCount>
                <collectionTime>String value</collectionTime>
                <coverageProfile>FAILED</coverageProfile>
                <interferenceProfile>FAILED</interferenceProfile>
                <loadProfile>FAILED</loadProfile>
                <macAddress>String value</macAddress>
                <noiseProfile>FAILED</noiseProfile>
                <operStatus>DOWN</operStatus>
                <poorCoverageClients>1</poorCoverageClients>
                <powerLevel>1</powerLevel>
                <rxUtilization>1</rxUtilization>
                <slotId>String value</slotId>
                <txUtilization>1</txUtilization>
            </historicalRFStatsDTO>
        </entity>
    </queryResponse>

## Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/HistoricalRFStats/42.json

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