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

Resource URL

/webacs/api/v4/data/HistoricalRFStats

Updated

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

Response Parameters

Attribute Description

channelNumber ChannelNumberEnum

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
  • _144
  • _149
  • _153
  • _157
  • _161
  • _165
  • _169
  • _173

clientCount int

Number of associated clients

collectionTime Date

The time collection of this record was finished.

Note: The date has an incorrect UTC offset. Add the appliance UTC offset to get the correct date.

coverageProfile RFProfileEnum

Allowed values:

  • FAILED
  • PASSED

ethernetMac MacAddress

MAC address of the ethernet interface on the AP

instanceOrigin InstanceOriginEnum

Allowed values:

  • UNCONCERNED
  • APPLICATION
  • NETWORK

instanceTenantId Integer

This is a tenant id for this instance.

interferenceProfile RFProfileEnum

Interference profile

Allowed values:

  • FAILED
  • PASSED

loadProfile RFProfileEnum

Load profile

Allowed values:

  • FAILED
  • PASSED

macAddress MacAddress

Base radio MAC address

noiseProfile RFProfileEnum

Noise profile

Allowed values:

  • FAILED
  • PASSED

operStatus RadioOperStatusEnum

Operational Status

Allowed values:

  • DOWN
  • UP
  • NOTASSOCIATED
  • UNKNOWN

powerLevel int

power level of the radio

slotId int

Slot ID of the radio

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/v4/data/HistoricalRFStats/15

<?xml version="1.0" ?>
<queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/HistoricalRFStats/15" rootUrl="https://localhost/webacs/api/v4/data">
  <entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://localhost/webacs/api/v4/data/HistoricalRFStats/15">
    <historicalRFStatsDTO displayName="String value" id="15" instanceTenantId="String value" 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>
      <collectionTime>2018-12-21T12:10:22.065+07:00</collectionTime>
      <ethernetMac>
        <octets>000a959d6816</octets>
      </ethernetMac>
      <macAddress>
        <octets>000a959d6816</octets>
      </macAddress>
      <slotId>1</slotId>
    </historicalRFStatsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

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

{
  "queryResponse" : {
    "@type" : "HistoricalRFStats",
    "@requestUrl" : "https://localhost/webacs/api/v4/data/HistoricalRFStats/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v4/data",
    "entity" : [ {
      "@dtoType" : "historicalRFStatsDTO",
      "@type" : "HistoricalRFStats",
      "@url" : "https://localhost/webacs/api/v4/data/HistoricalRFStats/15",
      "historicalRFStatsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@instanceTenantId" : "String value",
        "@uuid" : "String value",
        "channelNumber" : "UNKNOWN",
        "clientCount" : 1,
        "collectionTime" : "2018-12-21T05:10:22.065Z",
        "coverageProfile" : "FAILED",
        "ethernetMac" : {
          "octets" : "000a959d6816"
        },
        "interferenceProfile" : "FAILED",
        "loadProfile" : "FAILED",
        "macAddress" : {
          "octets" : "000a959d6816"
        },
        "noiseProfile" : "FAILED",
        "operStatus" : "DOWN",
        "powerLevel" : 1,
        "slotId" : 1
      }
    } ]
  }
}