Represents client statistics 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 client or time.
Since Product Version: 1.2
Resource URL
/webacs/api/v1/data/HistoricalClientStatsResponse Parameters
Type | Attribute Name | Description |
---|---|---|
long |
bytesReceived |
number of bytes received during the session |
long |
bytesSent |
number of bytes sent during the session |
long |
collectionTime |
The time collection of this record was finished, measured in milliseconds since the Unix epoch. |
float |
dataRate |
Datarate reading |
long |
dataRetries |
Number data retries during the session |
String |
instanceUuid |
This is a uuid for this instance. |
String |
macAddress |
Client MAC address |
long |
packetsReceived |
number packets received during the session |
long |
packetsSent |
Number of packets sent during the session |
long |
raPacketsDropped |
number of IPv6 RA packets dropped during the session |
int |
rssi |
RSSI reading |
long |
rtsRetries |
number of RTS retries during the session |
long |
rxBytesDropped |
Number of Rx bytes dropped during the session |
long |
rxPacketsDropped |
Number of Rx packets dropped during the session |
int |
snr |
SNR reading |
long |
txBytesDropped |
Number of Tx bytes dropped during the session |
long |
txPacketsDropped |
Number of Tx packets dropped during the session |
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://172.25.123.114/webacs/api/v1/data/HistoricalClientStats/15
<?xml version="1.0" ?> <queryResponse type="HistoricalClientStats" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/HistoricalClientStats/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="historicalClientStatsDTO" type="HistoricalClientStats" url="https://172.25.123.114/webacs/api/v1/data/HistoricalClientStats/15"> <historicalClientStatsDTO displayName="String value" id="15" uuid="String value"> <bytesReceived>2</bytesReceived> <bytesSent>2</bytesSent> <collectionTime>2</collectionTime> <dataRate>3.0</dataRate> <dataRetries>2</dataRetries> <macAddress>String value</macAddress> <packetsReceived>2</packetsReceived> <packetsSent>2</packetsSent> <raPacketsDropped>2</raPacketsDropped> <rssi>1</rssi> <rtsRetries>2</rtsRetries> <rxBytesDropped>2</rxBytesDropped> <rxPacketsDropped>2</rxPacketsDropped> <snr>1</snr> <txBytesDropped>2</txBytesDropped> <txPacketsDropped>2</txPacketsDropped> </historicalClientStatsDTO> </entity> </queryResponse>
Sample JSON Payload
https://172.25.123.114/webacs/api/v1/data/HistoricalClientStats/15.json
{ "queryResponse" : { "@type" : "HistoricalClientStats", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/HistoricalClientStats\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "historicalClientStatsDTO", "@type" : "HistoricalClientStats", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/HistoricalClientStats\/15", "historicalClientStatsDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "bytesReceived" : 2, "bytesSent" : 2, "collectionTime" : 2, "dataRate" : 3, "dataRetries" : 2, "macAddress" : "String value", "packetsReceived" : 2, "packetsSent" : 2, "raPacketsDropped" : 2, "rssi" : 1, "rtsRetries" : 2, "rxBytesDropped" : 2, "rxPacketsDropped" : 2, "snr" : 1, "txBytesDropped" : 2, "txPacketsDropped" : 2 } } } }