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 |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v2/data/HistoricalRFStats UnmodifiedThis resource has not been modified since the previous API version.
DeprecatedThis version has been deprecated due to poor performance in large-scale environments. Please use v3 v3/data/HistoricalRFStats and v3/data/HistoricalRFLoadStats.
Response Parameters
Attribute | Description |
---|---|
channelNumber ChannelNumberEnum |
Channel number that the radio is operating on Allowed values: |
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: |
ethernetMac String |
MAC address of the ethernet interface on the AP |
interferenceProfile RFProfileEnum |
Interference profile Allowed values: |
loadProfile RFProfileEnum |
Load profile Allowed values: |
macAddress String |
Base radio MAC address |
noiseProfile RFProfileEnum |
Noise profile Allowed values: |
operStatus RadioOperStatusEnum |
Operational Status Allowed values: |
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://localhost/webacs/api/v2/data/HistoricalRFStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalRFStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/HistoricalRFStats/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="historicalRFStatsDTO" type="HistoricalRFStats" url="https://localhost/webacs/api/v2/data/HistoricalRFStats/15">
<historicalRFStatsDTO displayName="String value" id="15" uuid="String value">
<channelNumber>UNKNOWN</channelNumber>
<channelUtilization>1</channelUtilization>
<clientCount>1</clientCount>
<collectionTime>String value</collectionTime>
<coverageProfile>FAILED</coverageProfile>
<ethernetMac>String value</ethernetMac>
<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://localhost/webacs/api/v2/data/HistoricalRFStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalRFStats",
"@requestUrl" : "https://localhost/webacs/api/v2/data/HistoricalRFStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "historicalRFStatsDTO",
"@type" : "HistoricalRFStats",
"@url" : "https://localhost/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
}
} ]
}
}