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 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/v3/data/HistoricalClientTraffics UnmodifiedThis resource has not been modified since the previous API version.
Response Parameters
Attribute | Description |
---|---|
collectionTime long |
The time collection of this record was finished, measured in milliseconds since the Unix epoch. |
dot11aReceived String |
total bytes received using 802.11a protocol |
dot11aSent long |
total bytes sent using 802.11a protocol |
dot11aThroughput long |
total throughput in Kbps using 802.11a protocol |
dot11acReceived long |
total bytes received using 802.11ac protocol |
dot11acSent long |
total bytes sent using 802.11ac protocol |
dot11acThroughput long |
total throughput in Kbps using 802.11ac protocol |
dot11bReceived String |
total bytes received using 802.11b protocol |
dot11bSent long |
total bytes sent using 802.11b protocol |
dot11bThroughput long |
total throughput in Kbps using 802.11b protocol |
dot11gReceived String |
total bytes received using 802.11g protocol |
dot11gSent long |
total bytes sent using 802.11g protocol |
dot11gThroughput long |
total throughput in Kbps using 802.11g protocol |
dot11n2_4Received String |
total bytes received using 802.11n protocol in 2.4GHz band |
dot11n2_4Sent long |
total bytes sent using 802.11n protocol in 2.4GHz band |
dot11n2_4Throughput long |
total throughput in Kbps using 802.11n protocol in 2.4GHz band |
dot11n5Received String |
total bytes received using 802.11n protocol in 5GHz band |
dot11n5Sent long |
total bytes sent using 802.11n protocol in 5GHz band |
dot11n5Throughput long |
total throughput in Kbps using 802.11n protocol in 5GHz band |
key String |
key represents the element |
received String |
total bytes received |
sent long |
total bytes sent |
subkey String |
subkey is used to further categorize client count |
throughput long |
total throughput in Kbps |
type ClientCountTypeEnum |
Type of count element Allowed values: |
wired100MReceived String |
total bytes sent from wired clients connected to wired switch on 100Mbps port |
wired100MSent long |
total bytes send from wired clients connected to wired switch on 100Mbps port |
wired100MThroughput long |
total throughput from wired clients connected to wired switch on 100Mbps port |
wired10MReceived String |
total bytes sent from wired clients connected to wired switch on 10Mbps port |
wired10MSent long |
total bytes send from wired clients connected to wired switch on 10Mbps port |
wired10MThroughput long |
total throughput from wired clients connected to wired switch on 10Mbps port |
wired1GReceived String |
total bytes sent from wired clients connected to wired switch on 1Gbps port |
wired1GSent long |
total bytes send from wired clients connected to wired switch on 1Gbps port |
wired1GThroughput long |
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://localhost/webacs/api/v3/data/HistoricalClientTraffics/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalClientTraffics" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/HistoricalClientTraffics/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="historicalClientTrafficsDTO" type="HistoricalClientTraffics" url="https://localhost/webacs/api/v3/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://localhost/webacs/api/v3/data/HistoricalClientTraffics/15.json
{
"queryResponse" : {
"@type" : "HistoricalClientTraffics",
"@requestUrl" : "https://localhost/webacs/api/v3/data/HistoricalClientTraffics/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "historicalClientTrafficsDTO",
"@type" : "HistoricalClientTraffics",
"@url" : "https://localhost/webacs/api/v3/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
}
} ]
}
}