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

# GET HistoricalRFLoadStats

Represents load 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: 3.2

- Jump To

- v1
- v2
- v3
- v4

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 unavailable for this API version

This resource was introduced in API version 3.

Resource unavailable for this API version

This resource was introduced in API version 3.

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

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
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.
ethernetMac String | MAC address of the ethernet interface on the AP
macAddress String | Base radio MAC address
poorCoverageClients int | Poor coverage clients
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/v3/data/HistoricalRFLoadStats/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFLoadStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v3/data/HistoricalRFLoadStats/15" rootUrl="https://10.64.88.203/webacs/api/v3/data">
      <entity dtoType="historicalRFLoadStatsDTO" type="HistoricalRFLoadStats" url="https://10.64.88.203/webacs/api/v3/data/HistoricalRFLoadStats/15">
        <historicalRFLoadStatsDTO displayName="String value" id="15" uuid="String value">
          <channelUtilization>1</channelUtilization>
          <clientCount>1</clientCount>
          <poorCoverageClients>1</poorCoverageClients>
          <rxUtilization>1</rxUtilization>
          <txUtilization>1</txUtilization>
          <collectionTime>String value</collectionTime>
          <ethernetMac>String value</ethernetMac>
          <macAddress>String value</macAddress>
          <slotId>String value</slotId>
        </historicalRFLoadStatsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "HistoricalRFLoadStats",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v3/data/HistoricalRFLoadStats/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "historicalRFLoadStatsDTO",
          "@type" : "HistoricalRFLoadStats",
          "@url" : "https://10.64.88.203/webacs/api/v3/data/HistoricalRFLoadStats/15",
          "historicalRFLoadStatsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "channelUtilization" : 1,
            "clientCount" : 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/v4/data/HistoricalRFLoadStats

Updated

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

## Response Parameters

Attribute | Description
--- | ---
channelUtilization int | Channel Utilization (%)
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.
ethernetMac MacAddress | MAC address of the ethernet interface on the AP
macAddress MacAddress | Base radio MAC address
poorCoverageClients int | Poor coverage clients
rxUtilization int | Rx Utilization (%)
slotId int | 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/v4/data/HistoricalRFLoadStats/15

    <?xml version="1.0" ?>
    <queryResponse type="HistoricalRFLoadStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/HistoricalRFLoadStats/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="historicalRFLoadStatsDTO" type="HistoricalRFLoadStats" url="https://10.64.88.203/webacs/api/v4/data/HistoricalRFLoadStats/15">
        <historicalRFLoadStatsDTO displayName="String value" id="15" uuid="String value">
          <channelUtilization>1</channelUtilization>
          <clientCount>1</clientCount>
          <poorCoverageClients>1</poorCoverageClients>
          <rxUtilization>1</rxUtilization>
          <txUtilization>1</txUtilization>
          <collectionTime>1986-07-24T00:00:00+05:30</collectionTime>
          <ethernetMac>
            <octets>000a959d6816</octets>
          </ethernetMac>
          <macAddress>
            <octets>000a959d6816</octets>
          </macAddress>
          <slotId>1</slotId>
        </historicalRFLoadStatsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

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

    {
      "queryResponse" : {
        "@type" : "HistoricalRFLoadStats",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/HistoricalRFLoadStats/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "historicalRFLoadStatsDTO",
          "@type" : "HistoricalRFLoadStats",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/HistoricalRFLoadStats/15",
          "historicalRFLoadStatsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "channelUtilization" : 1,
            "clientCount" : 1,
            "collectionTime" : "1986-07-23T18:30:00.000Z",
            "ethernetMac" : {
              "octets" : "000a959d6816"
            },
            "macAddress" : {
              "octets" : "000a959d6816"
            },
            "poorCoverageClients" : 1,
            "rxUtilization" : 1,
            "slotId" : 1,
            "txUtilization" : 1
          }
        } ]
      }
    }