Represents client traffic information collected in last 24 hours with 15 minutes (default) interval. The dataset could be really big. When querying, you must use paged query or filtered by entity or time. Otherwise it could be resulted in longer running query to affect system performance.
Since Product Version: 1.2
Resource URL
/webacs/api/v1/data/HistoricalClientTrafficsResponse Parameters
Type | Attribute Name | Description |
---|---|---|
long |
collectionTime |
The time collection of this record was finished, measured in milliseconds since the Unix epoch. |
String |
dot11aReceived |
total bytes received using 802.11a protocol |
long |
dot11aSent |
total bytes sent using 802.11a protocol |
long |
dot11aThroughput |
total throughput in Kbps using 802.11a protocol |
long |
dot11acReceived |
total bytes received using 802.11ac protocol |
long |
dot11acSent |
total bytes sent using 802.11ac protocol |
long |
dot11acThroughput |
total throughput in Kbps using 802.11ac protocol |
String |
dot11bReceived |
total bytes received using 802.11b protocol |
long |
dot11bSent |
total bytes sent using 802.11b protocol |
long |
dot11bThroughput |
total throughput in Kbps using 802.11b protocol |
String |
dot11gReceived |
total bytes received using 802.11g protocol |
long |
dot11gSent |
total bytes sent using 802.11g protocol |
long |
dot11gThroughput |
total throughput in Kbps using 802.11g protocol |
String |
dot11n2_4Received |
total bytes received using 802.11n protocol in 2.4GHz band |
long |
dot11n2_4Sent |
total bytes sent using 802.11n protocol in 2.4GHz band |
long |
dot11n2_4Throughput |
total throughput in Kbps using 802.11n protocol in 2.4GHz band |
String |
dot11n5Received |
total bytes received using 802.11n protocol in 5GHz band |
long |
dot11n5Sent |
total bytes sent using 802.11n protocol in 5GHz band |
long |
dot11n5Throughput |
total throughput in Kbps using 802.11n protocol in 5GHz band |
String |
instanceUuid |
This is a uuid for this instance. |
String |
key |
key represents the element |
String |
received |
total bytes received |
long |
sent |
total bytes sent |
String |
subkey |
subkey is used to further categorize client count |
long |
throughput |
total throughput in Kbps |
ClientCountTypeEnum |
type |
Type of count element Allowed values:
|
String |
wired100MReceived |
total bytes sent from wired clients connected to wired switch on 100Mbps port |
long |
wired100MSent |
total bytes send from wired clients connected to wired switch on 100Mbps port |
long |
wired100MThroughput |
total throughput from wired clients connected to wired switch on 100Mbps port |
String |
wired10MReceived |
total bytes sent from wired clients connected to wired switch on 10Mbps port |
long |
wired10MSent |
total bytes send from wired clients connected to wired switch on 10Mbps port |
long |
wired10MThroughput |
total throughput from wired clients connected to wired switch on 10Mbps port |
String |
wired1GReceived |
total bytes sent from wired clients connected to wired switch on 1Gbps port |
long |
wired1GSent |
total bytes send from wired clients connected to wired switch on 1Gbps port |
long |
wired1GThroughput |
total throughput from wired clients connected to wired switch on 1Gbps port |
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/HistoricalClientTraffics/15
<?xml version="1.0" ?> <queryResponse type="HistoricalClientTraffics" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/HistoricalClientTraffics/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="historicalClientTrafficsDTO" type="HistoricalClientTraffics" url="https://172.25.123.114/webacs/api/v1/data/HistoricalClientTraffics/15"> <historicalClientTrafficsDTO displayName="String value" id="15" uuid="String value"> <collectionTime>2</collectionTime> <dot11aReceived>String value</dot11aReceived> <dot11aSent>2</dot11aSent> <dot11aThroughput>2</dot11aThroughput> <dot11acReceived>2</dot11acReceived> <dot11acSent>2</dot11acSent> <dot11acThroughput>2</dot11acThroughput> <dot11bReceived>String value</dot11bReceived> <dot11bSent>2</dot11bSent> <dot11bThroughput>2</dot11bThroughput> <dot11gReceived>String value</dot11gReceived> <dot11gSent>2</dot11gSent> <dot11gThroughput>2</dot11gThroughput> <dot11n2_4Received>String value</dot11n2_4Received> <dot11n2_4Sent>2</dot11n2_4Sent> <dot11n2_4Throughput>2</dot11n2_4Throughput> <dot11n5Received>String value</dot11n5Received> <dot11n5Sent>2</dot11n5Sent> <dot11n5Throughput>2</dot11n5Throughput> <key>String value</key> <received>String value</received> <sent>2</sent> <subkey>String value</subkey> <throughput>2</throughput> <type>DEVICE</type> <wired100MReceived>String value</wired100MReceived> <wired100MSent>2</wired100MSent> <wired100MThroughput>2</wired100MThroughput> <wired10MReceived>String value</wired10MReceived> <wired10MSent>2</wired10MSent> <wired10MThroughput>2</wired10MThroughput> <wired1GReceived>String value</wired1GReceived> <wired1GSent>2</wired1GSent> <wired1GThroughput>2</wired1GThroughput> </historicalClientTrafficsDTO> </entity> </queryResponse>
Sample JSON Payload
https://172.25.123.114/webacs/api/v1/data/HistoricalClientTraffics/15.json
{ "queryResponse" : { "@type" : "HistoricalClientTraffics", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/HistoricalClientTraffics\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "historicalClientTrafficsDTO", "@type" : "HistoricalClientTraffics", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/HistoricalClientTraffics\/15", "historicalClientTrafficsDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "collectionTime" : 2, "dot11aReceived" : "String value", "dot11aSent" : 2, "dot11aThroughput" : 2, "dot11acReceived" : 2, "dot11acSent" : 2, "dot11acThroughput" : 2, "dot11bReceived" : "String value", "dot11bSent" : 2, "dot11bThroughput" : 2, "dot11gReceived" : "String value", "dot11gSent" : 2, "dot11gThroughput" : 2, "dot11n2_4Received" : "String value", "dot11n2_4Sent" : 2, "dot11n2_4Throughput" : 2, "dot11n5Received" : "String value", "dot11n5Sent" : 2, "dot11n5Throughput" : 2, "key" : "String value", "received" : "String value", "sent" : 2, "subkey" : "String value", "throughput" : 2, "type" : "DEVICE", "wired100MReceived" : "String value", "wired100MSent" : 2, "wired100MThroughput" : 2, "wired10MReceived" : "String value", "wired10MSent" : 2, "wired10MThroughput" : 2, "wired1GReceived" : "String value", "wired1GSent" : 2, "wired1GThroughput" : 2 } } } }