
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager 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

- 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/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 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
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 | Allowed values FAILED PASSED
ethernetMac String | MAC address of the ethernet interface on the AP
interferenceProfile RFProfileEnum | Interference profile Allowed values FAILED PASSED
loadProfile RFProfileEnum | Load profile Allowed values FAILED PASSED
macAddress String | Base radio MAC address
noiseProfile RFProfileEnum | Noise profile Allowed values FAILED PASSED
operStatus RadioOperStatusEnum | Operational Status Allowed values 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://10.64.88.203/webacs/api/v1/data/HistoricalRFStats/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/HistoricalRFStats/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
      <entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://10.64.88.203/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://10.64.88.203/webacs/api/v1/data/HistoricalRFStats/15.json

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

### 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/HistoricalRFStats

Unmodified

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

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 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
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 | Allowed values FAILED PASSED
ethernetMac String | MAC address of the ethernet interface on the AP
interferenceProfile RFProfileEnum | Interference profile Allowed values FAILED PASSED
loadProfile RFProfileEnum | Load profile Allowed values FAILED PASSED
macAddress String | Base radio MAC address
noiseProfile RFProfileEnum | Noise profile Allowed values FAILED PASSED
operStatus RadioOperStatusEnum | Operational Status Allowed values 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://10.64.88.203/webacs/api/v2/data/HistoricalRFStats/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v2/data/HistoricalRFStats/15" rootUrl="https://10.64.88.203/webacs/api/v2/data">
      <entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://10.64.88.203/webacs/api/v2/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://10.64.88.203/webacs/api/v2/data/HistoricalRFStats/15.json

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

### 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/HistoricalRFStats

Updated

Since version 3 this API does not contain load statistics. Please use data/HistoricalRFLoadStats.

Deprecated

This version has been deprecated. Please use v4.

## 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 String | The time collection of this record was finished, measured in milliseconds since the Unix epoch.
coverageProfile RFProfileEnum | Allowed values FAILED PASSED
ethernetMac String | MAC address of the ethernet interface on the AP
interferenceProfile RFProfileEnum | Interference profile Allowed values FAILED PASSED
loadProfile RFProfileEnum | Load profile Allowed values FAILED PASSED
macAddress String | 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 String | 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://10.64.88.203/webacs/api/v3/data/HistoricalRFStats/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/HistoricalRFStats/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://10.64.88.203/webacs/api/v3/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>
          <collectionTime>String value</collectionTime>
          <ethernetMac>String value</ethernetMac>
          <macAddress>String value</macAddress>
          <slotId>String value</slotId>
        </historicalRFStatsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "HistoricalRFStats",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/HistoricalRFStats/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "historicalRFStatsDTO",
          "@type" : "HistoricalRFStats",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/HistoricalRFStats/15",
          "historicalRFStatsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "channelNumber" : "UNKNOWN",
            "clientCount" : 1,
            "collectionTime" : "String value",
            "coverageProfile" : "FAILED",
            "ethernetMac" : "String value",
            "interferenceProfile" : "FAILED",
            "loadProfile" : "FAILED",
            "macAddress" : "String value",
            "noiseProfile" : "FAILED",
            "operStatus" : "DOWN",
            "powerLevel" : 1,
            "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/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. Please see the FAQ for details.
coverageProfile RFProfileEnum | Allowed values FAILED PASSED
ethernetMac MacAddress | MAC address of the ethernet interface on the AP
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://10.64.88.203/webacs/api/v4/data/HistoricalRFStats/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/HistoricalRFStats/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://10.64.88.203/webacs/api/v4/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>
          <collectionTime>1986-07-24T00:00:00+05:30</collectionTime>
          <ethernetMac>
            <octets>000a959d6816</octets>
          </ethernetMac>
          <macAddress>
            <octets>000a959d6816</octets>
          </macAddress>
          <slotId>1</slotId>
        </historicalRFStatsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "HistoricalRFStats",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/HistoricalRFStats/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "historicalRFStatsDTO",
          "@type" : "HistoricalRFStats",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/HistoricalRFStats/15",
          "historicalRFStatsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "channelNumber" : "UNKNOWN",
            "clientCount" : 1,
            "collectionTime" : "1986-07-23T18:30:00.000Z",
            "coverageProfile" : "FAILED",
            "ethernetMac" : {
              "octets" : "000a959d6816"
            },
            "interferenceProfile" : "FAILED",
            "loadProfile" : "FAILED",
            "macAddress" : {
              "octets" : "000a959d6816"
            },
            "noiseProfile" : "FAILED",
            "operStatus" : "DOWN",
            "powerLevel" : 1,
            "slotId" : 1
          }
        } ]
      }
    }