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
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 UpdatedSince 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://localhost/webacs/api/v4/data/HistoricalRFLoadStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFLoadStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/HistoricalRFLoadStats/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="historicalRFLoadStatsDTO" type="HistoricalRFLoadStats" url="https://localhost/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>2019-08-20T09:02:33.369Z</collectionTime>
<ethernetMac>
<octets>000a959d6816</octets>
</ethernetMac>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<slotId>1</slotId>
</historicalRFLoadStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/HistoricalRFLoadStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFLoadStats",
"@requestUrl" : "https://localhost/webacs/api/v4/data/HistoricalRFLoadStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "historicalRFLoadStatsDTO",
"@type" : "HistoricalRFLoadStats",
"@url" : "https://localhost/webacs/api/v4/data/HistoricalRFLoadStats/15",
"historicalRFLoadStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "2019-08-20T09:02:33.369Z",
"ethernetMac" : {
"octets" : "000a959d6816"
},
"macAddress" : {
"octets" : "000a959d6816"
},
"poorCoverageClients" : 1,
"rxUtilization" : 1,
"slotId" : 1,
"txUtilization" : 1
}
} ]
}
}