Represents clients traffic information collected during last polling cycle in NCS.
Resource URL
/webacs/api/v1/data/ClientTrafficsSince : 1.2
Response Parameters
| Type | Attribute Name | Description |
|---|---|---|
|
long |
collectionTime |
binary time stamp representing the last collection time |
|
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 |
|
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 |
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 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://192.168.116.207/webacs/api/v1/data/ClientTraffics/42
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/ClientTraffics/42" responseType="getEntity">
<entity url="/webacs/data/className/15" type="className" dtoType="clientTrafficsDTO_$$_javassist_5999">
<clientTrafficsDTO id="15" displayName="String value">
<collectionTime>2</collectionTime>
<dot11aReceived>String value</dot11aReceived>
<dot11aSent>2</dot11aSent>
<dot11aThroughput>2</dot11aThroughput>
<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>
</clientTrafficsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://192.168.116.207/webacs/api/v1/data/ClientTraffics/42.json
{
"queryResponse" : {
"@rootUrl" : "\/webacs\/data",
"@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/ClientTraffics\/42",
"@responseType" : "getEntity",
"entity" : {
"@url" : "\/webacs\/data\/className\/15",
"@type" : "className",
"@dtoType" : "clientTrafficsDTO_$$_javassist_5999",
"clientTrafficsDTO" : {
"@id" : "15",
"@displayName" : "String value",
"collectionTime" : 2,
"dot11aReceived" : "String value",
"dot11aSent" : 2,
"dot11aThroughput" : 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
}
}
}
}