Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/ClientTraffics
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
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
|
dot11ax2_4Received
long
|
Total bytes received using 802.11ax protocol in 2.4GHz band
|
dot11ax2_4Sent
long
|
Total bytes sent using 802.11ax protocol in 2.4GHz band
|
dot11ax2_4Throughput
long
|
Total throughput in Kbps using 802.11ax protocol in 2.4GHz band
|
dot11ax5Received
long
|
Total bytes received using 802.11ax protocol in 5GHz band
|
dot11ax5Sent
long
|
Total bytes sent using 802.11ax protocol in 5GHz band
|
dot11ax5Throughput
long
|
Total throughput in Kbps using 802.11ax protocol in 5GHz band
|
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
|
|
sent
long
|
|
subkey
String
|
Subkey is used to further categorize client count
|
throughput
long
|
|
type
ClientCountTypeEnum
|
|
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
|
wired10GReceived
long
|
Total bytes received by wired clients connected to wired switch on 10Gbps port
|
wired10GSent
long
|
Total bytes send from wired clients connected to wired switch on 10Gbps port
|
wired10GThroughput
long
|
Total throughput from wired clients connected to wired switch on 10Gbps 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://10.56.58.149/webacs/api/v1/data/ClientTraffics/15
<?xml version="1.0" ?>
<queryResponse type="ClientTraffics" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v1/data/ClientTraffics/15" rootUrl="https://10.56.58.149/webacs/api/v1/data">
<entity dtoType="clientTrafficsDTO" type="ClientTraffics" url="https://10.56.58.149/webacs/api/v1/data/ClientTraffics/15">
<clientTrafficsDTO displayName="String value" id="15" uuid="String value">
<collectionTime>2</collectionTime>
<dot11aSent>2</dot11aSent>
<dot11aThroughput>2</dot11aThroughput>
<dot11acReceived>2</dot11acReceived>
<dot11acSent>2</dot11acSent>
<dot11acThroughput>2</dot11acThroughput>
<dot11ax2_4Received>2</dot11ax2_4Received>
<dot11ax2_4Sent>2</dot11ax2_4Sent>
<dot11ax2_4Throughput>2</dot11ax2_4Throughput>
<dot11ax5Received>2</dot11ax5Received>
<dot11ax5Sent>2</dot11ax5Sent>
<dot11ax5Throughput>2</dot11ax5Throughput>
<dot11bSent>2</dot11bSent>
<dot11bThroughput>2</dot11bThroughput>
<dot11gSent>2</dot11gSent>
<dot11gThroughput>2</dot11gThroughput>
<dot11n2_4Sent>2</dot11n2_4Sent>
<dot11n2_4Throughput>2</dot11n2_4Throughput>
<dot11n5Sent>2</dot11n5Sent>
<dot11n5Throughput>2</dot11n5Throughput>
<key>String value</key>
<sent>2</sent>
<subkey>String value</subkey>
<throughput>2</throughput>
<type>DEVICE</type>
<wired100MSent>2</wired100MSent>
<wired100MThroughput>2</wired100MThroughput>
<wired10GReceived>2</wired10GReceived>
<wired10GSent>2</wired10GSent>
<wired10GThroughput>2</wired10GThroughput>
<wired10MSent>2</wired10MSent>
<wired10MThroughput>2</wired10MThroughput>
<wired1GSent>2</wired1GSent>
<wired1GThroughput>2</wired1GThroughput>
<dot11aReceived>String value</dot11aReceived>
<dot11bReceived>String value</dot11bReceived>
<dot11gReceived>String value</dot11gReceived>
<dot11n2_4Received>String value</dot11n2_4Received>
<dot11n5Received>String value</dot11n5Received>
<received>String value</received>
<wired100MReceived>String value</wired100MReceived>
<wired10MReceived>String value</wired10MReceived>
<wired1GReceived>String value</wired1GReceived>
</clientTrafficsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.56.58.149/webacs/api/v1/data/ClientTraffics/15.json
{
"queryResponse" : {
"@type" : "ClientTraffics",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/data\/ClientTraffics\/15",
"@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "clientTrafficsDTO",
"@type" : "ClientTraffics",
"@url" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/data\/ClientTraffics\/15",
"clientTrafficsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"collectionTime" : 2,
"dot11aSent" : 2,
"dot11aThroughput" : 2,
"dot11acReceived" : 2,
"dot11acSent" : 2,
"dot11acThroughput" : 2,
"dot11ax2_4Received" : 2,
"dot11ax2_4Sent" : 2,
"dot11ax2_4Throughput" : 2,
"dot11ax5Received" : 2,
"dot11ax5Sent" : 2,
"dot11ax5Throughput" : 2,
"dot11bSent" : 2,
"dot11bThroughput" : 2,
"dot11gSent" : 2,
"dot11gThroughput" : 2,
"dot11n2_4Sent" : 2,
"dot11n2_4Throughput" : 2,
"dot11n5Sent" : 2,
"dot11n5Throughput" : 2,
"key" : "String value",
"sent" : 2,
"subkey" : "String value",
"throughput" : 2,
"type" : "DEVICE",
"wired100MSent" : 2,
"wired100MThroughput" : 2,
"wired10GReceived" : 2,
"wired10GSent" : 2,
"wired10GThroughput" : 2,
"wired10MSent" : 2,
"wired10MThroughput" : 2,
"wired1GSent" : 2,
"wired1GThroughput" : 2,
"dot11aReceived" : "String value",
"dot11bReceived" : "String value",
"dot11gReceived" : "String value",
"dot11n2_4Received" : "String value",
"dot11n5Received" : "String value",
"received" : "String value",
"wired100MReceived" : "String value",
"wired10MReceived" : "String value",
"wired1GReceived" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/ClientTraffics
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
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
|
dot11ax2_4Received
long
|
Total bytes received using 802.11ax protocol in 2.4GHz band
|
dot11ax2_4Sent
long
|
Total bytes sent using 802.11ax protocol in 2.4GHz band
|
dot11ax2_4Throughput
long
|
Total throughput in Kbps using 802.11ax protocol in 2.4GHz band
|
dot11ax5Received
long
|
Total bytes received using 802.11ax protocol in 5GHz band
|
dot11ax5Sent
long
|
Total bytes sent using 802.11ax protocol in 5GHz band
|
dot11ax5Throughput
long
|
Total throughput in Kbps using 802.11ax protocol in 5GHz band
|
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
|
|
sent
long
|
|
subkey
String
|
Subkey is used to further categorize client count
|
throughput
long
|
|
type
ClientCountTypeEnum
|
|
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
|
wired10GReceived
long
|
Total bytes received by wired clients connected to wired switch on 10Gbps port
|
wired10GSent
long
|
Total bytes send from wired clients connected to wired switch on 10Gbps port
|
wired10GThroughput
long
|
Total throughput from wired clients connected to wired switch on 10Gbps 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://10.56.58.149/webacs/api/v2/data/ClientTraffics/15
<?xml version="1.0" ?>
<queryResponse type="ClientTraffics" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v2/data/ClientTraffics/15" rootUrl="https://10.56.58.149/webacs/api/v2/data">
<entity dtoType="clientTrafficsDTO" type="ClientTraffics" url="https://10.56.58.149/webacs/api/v2/data/ClientTraffics/15">
<clientTrafficsDTO displayName="String value" id="15" uuid="String value">
<collectionTime>2</collectionTime>
<dot11aSent>2</dot11aSent>
<dot11aThroughput>2</dot11aThroughput>
<dot11acReceived>2</dot11acReceived>
<dot11acSent>2</dot11acSent>
<dot11acThroughput>2</dot11acThroughput>
<dot11ax2_4Received>2</dot11ax2_4Received>
<dot11ax2_4Sent>2</dot11ax2_4Sent>
<dot11ax2_4Throughput>2</dot11ax2_4Throughput>
<dot11ax5Received>2</dot11ax5Received>
<dot11ax5Sent>2</dot11ax5Sent>
<dot11ax5Throughput>2</dot11ax5Throughput>
<dot11bSent>2</dot11bSent>
<dot11bThroughput>2</dot11bThroughput>
<dot11gSent>2</dot11gSent>
<dot11gThroughput>2</dot11gThroughput>
<dot11n2_4Sent>2</dot11n2_4Sent>
<dot11n2_4Throughput>2</dot11n2_4Throughput>
<dot11n5Sent>2</dot11n5Sent>
<dot11n5Throughput>2</dot11n5Throughput>
<key>String value</key>
<sent>2</sent>
<subkey>String value</subkey>
<throughput>2</throughput>
<type>DEVICE</type>
<wired100MSent>2</wired100MSent>
<wired100MThroughput>2</wired100MThroughput>
<wired10GReceived>2</wired10GReceived>
<wired10GSent>2</wired10GSent>
<wired10GThroughput>2</wired10GThroughput>
<wired10MSent>2</wired10MSent>
<wired10MThroughput>2</wired10MThroughput>
<wired1GSent>2</wired1GSent>
<wired1GThroughput>2</wired1GThroughput>
<dot11aReceived>String value</dot11aReceived>
<dot11bReceived>String value</dot11bReceived>
<dot11gReceived>String value</dot11gReceived>
<dot11n2_4Received>String value</dot11n2_4Received>
<dot11n5Received>String value</dot11n5Received>
<received>String value</received>
<wired100MReceived>String value</wired100MReceived>
<wired10MReceived>String value</wired10MReceived>
<wired1GReceived>String value</wired1GReceived>
</clientTrafficsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.56.58.149/webacs/api/v2/data/ClientTraffics/15.json
{
"queryResponse" : {
"@type" : "ClientTraffics",
"@requestUrl" : "https://10.56.58.149/webacs/api/v2/data/ClientTraffics/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.56.58.149/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "clientTrafficsDTO",
"@type" : "ClientTraffics",
"@url" : "https://10.56.58.149/webacs/api/v2/data/ClientTraffics/15",
"clientTrafficsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"collectionTime" : 2,
"dot11aReceived" : "String value",
"dot11aSent" : 2,
"dot11aThroughput" : 2,
"dot11acReceived" : 2,
"dot11acSent" : 2,
"dot11acThroughput" : 2,
"dot11ax2_4Received" : 2,
"dot11ax2_4Sent" : 2,
"dot11ax2_4Throughput" : 2,
"dot11ax5Received" : 2,
"dot11ax5Sent" : 2,
"dot11ax5Throughput" : 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,
"wired10GReceived" : 2,
"wired10GSent" : 2,
"wired10GThroughput" : 2,
"wired10MReceived" : "String value",
"wired10MSent" : 2,
"wired10MThroughput" : 2,
"wired1GReceived" : "String value",
"wired1GSent" : 2,
"wired1GThroughput" : 2
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/ClientTraffics
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
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
|
dot11ax2_4Received
long
|
Total bytes received using 802.11ax protocol in 2.4GHz band
|
dot11ax2_4Sent
long
|
Total bytes sent using 802.11ax protocol in 2.4GHz band
|
dot11ax2_4Throughput
long
|
Total throughput in Kbps using 802.11ax protocol in 2.4GHz band
|
dot11ax5Received
long
|
Total bytes received using 802.11ax protocol in 5GHz band
|
dot11ax5Sent
long
|
Total bytes sent using 802.11ax protocol in 5GHz band
|
dot11ax5Throughput
long
|
Total throughput in Kbps using 802.11ax protocol in 5GHz band
|
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
|
|
sent
long
|
|
subkey
String
|
Subkey is used to further categorize client count
|
throughput
long
|
|
type
ClientCountTypeEnum
|
|
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
|
wired10GReceived
long
|
Total bytes received by wired clients connected to wired switch on 10Gbps port
|
wired10GSent
long
|
Total bytes send from wired clients connected to wired switch on 10Gbps port
|
wired10GThroughput
long
|
Total throughput from wired clients connected to wired switch on 10Gbps 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://10.56.58.149/webacs/api/v3/data/ClientTraffics/15
<?xml version="1.0" ?>
<queryResponse type="ClientTraffics" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v3/data/ClientTraffics/15" rootUrl="https://10.56.58.149/webacs/api/v3/data">
<entity dtoType="clientTrafficsDTO" type="ClientTraffics" url="https://10.56.58.149/webacs/api/v3/data/ClientTraffics/15">
<clientTrafficsDTO displayName="String value" id="15" uuid="String value">
<collectionTime>2</collectionTime>
<dot11aSent>2</dot11aSent>
<dot11aThroughput>2</dot11aThroughput>
<dot11acReceived>2</dot11acReceived>
<dot11acSent>2</dot11acSent>
<dot11acThroughput>2</dot11acThroughput>
<dot11ax2_4Received>2</dot11ax2_4Received>
<dot11ax2_4Sent>2</dot11ax2_4Sent>
<dot11ax2_4Throughput>2</dot11ax2_4Throughput>
<dot11ax5Received>2</dot11ax5Received>
<dot11ax5Sent>2</dot11ax5Sent>
<dot11ax5Throughput>2</dot11ax5Throughput>
<dot11bSent>2</dot11bSent>
<dot11bThroughput>2</dot11bThroughput>
<dot11gSent>2</dot11gSent>
<dot11gThroughput>2</dot11gThroughput>
<dot11n2_4Sent>2</dot11n2_4Sent>
<dot11n2_4Throughput>2</dot11n2_4Throughput>
<dot11n5Sent>2</dot11n5Sent>
<dot11n5Throughput>2</dot11n5Throughput>
<key>String value</key>
<sent>2</sent>
<subkey>String value</subkey>
<throughput>2</throughput>
<type>DEVICE</type>
<wired100MSent>2</wired100MSent>
<wired100MThroughput>2</wired100MThroughput>
<wired10GReceived>2</wired10GReceived>
<wired10GSent>2</wired10GSent>
<wired10GThroughput>2</wired10GThroughput>
<wired10MSent>2</wired10MSent>
<wired10MThroughput>2</wired10MThroughput>
<wired1GSent>2</wired1GSent>
<wired1GThroughput>2</wired1GThroughput>
<dot11aReceived>String value</dot11aReceived>
<dot11bReceived>String value</dot11bReceived>
<dot11gReceived>String value</dot11gReceived>
<dot11n2_4Received>String value</dot11n2_4Received>
<dot11n5Received>String value</dot11n5Received>
<received>String value</received>
<wired100MReceived>String value</wired100MReceived>
<wired10MReceived>String value</wired10MReceived>
<wired1GReceived>String value</wired1GReceived>
</clientTrafficsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.56.58.149/webacs/api/v3/data/ClientTraffics/15.json
{
"queryResponse" : {
"@type" : "ClientTraffics",
"@requestUrl" : "https://10.56.58.149/webacs/api/v3/data/ClientTraffics/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.56.58.149/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "clientTrafficsDTO",
"@type" : "ClientTraffics",
"@url" : "https://10.56.58.149/webacs/api/v3/data/ClientTraffics/15",
"clientTrafficsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"collectionTime" : 2,
"dot11aReceived" : "String value",
"dot11aSent" : 2,
"dot11aThroughput" : 2,
"dot11acReceived" : 2,
"dot11acSent" : 2,
"dot11acThroughput" : 2,
"dot11ax2_4Received" : 2,
"dot11ax2_4Sent" : 2,
"dot11ax2_4Throughput" : 2,
"dot11ax5Received" : 2,
"dot11ax5Sent" : 2,
"dot11ax5Throughput" : 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,
"wired10GReceived" : 2,
"wired10GSent" : 2,
"wired10GThroughput" : 2,
"wired10MReceived" : "String value",
"wired10MSent" : 2,
"wired10MThroughput" : 2,
"wired1GReceived" : "String value",
"wired1GSent" : 2,
"wired1GThroughput" : 2
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/ClientTraffics
Updated
Since version 4 type of attributes representing received traffic is long instead of String.
Response Parameters
collectionTime
long
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
dot11aReceived
long
|
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
|
dot11ax2_4Received
long
|
Total bytes received using 802.11ax protocol in 2.4GHz band
|
dot11ax2_4Sent
long
|
Total bytes sent using 802.11ax protocol in 2.4GHz band
|
dot11ax2_4Throughput
long
|
Total throughput in Kbps using 802.11ax protocol in 2.4GHz band
|
dot11ax5Received
long
|
Total bytes received using 802.11ax protocol in 5GHz band
|
dot11ax5Sent
long
|
Total bytes sent using 802.11ax protocol in 5GHz band
|
dot11ax5Throughput
long
|
Total throughput in Kbps using 802.11ax protocol in 5GHz band
|
dot11bReceived
long
|
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
long
|
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
long
|
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
long
|
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
long
|
|
sent
long
|
|
subkey
String
|
Subkey is used to further categorize client count
|
throughput
long
|
|
type
ClientCountTypeEnum
|
|
wired100MReceived
long
|
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
|
wired10GReceived
long
|
Total bytes received by wired clients connected to wired switch on 10Gbps port
|
wired10GSent
long
|
Total bytes send from wired clients connected to wired switch on 10Gbps port
|
wired10GThroughput
long
|
Total throughput from wired clients connected to wired switch on 10Gbps port
|
wired10MReceived
long
|
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
long
|
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://10.56.58.149/webacs/api/v4/data/ClientTraffics/15
<?xml version="1.0" ?>
<queryResponse type="ClientTraffics" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v4/data/ClientTraffics/15" rootUrl="https://10.56.58.149/webacs/api/v4/data">
<entity dtoType="clientTrafficsDTO" type="ClientTraffics" url="https://10.56.58.149/webacs/api/v4/data/ClientTraffics/15">
<clientTrafficsDTO displayName="String value" id="15" uuid="String value">
<collectionTime>2</collectionTime>
<dot11aSent>2</dot11aSent>
<dot11aThroughput>2</dot11aThroughput>
<dot11acReceived>2</dot11acReceived>
<dot11acSent>2</dot11acSent>
<dot11acThroughput>2</dot11acThroughput>
<dot11ax2_4Received>2</dot11ax2_4Received>
<dot11ax2_4Sent>2</dot11ax2_4Sent>
<dot11ax2_4Throughput>2</dot11ax2_4Throughput>
<dot11ax5Received>2</dot11ax5Received>
<dot11ax5Sent>2</dot11ax5Sent>
<dot11ax5Throughput>2</dot11ax5Throughput>
<dot11bSent>2</dot11bSent>
<dot11bThroughput>2</dot11bThroughput>
<dot11gSent>2</dot11gSent>
<dot11gThroughput>2</dot11gThroughput>
<dot11n2_4Sent>2</dot11n2_4Sent>
<dot11n2_4Throughput>2</dot11n2_4Throughput>
<dot11n5Sent>2</dot11n5Sent>
<dot11n5Throughput>2</dot11n5Throughput>
<key>String value</key>
<sent>2</sent>
<subkey>String value</subkey>
<throughput>2</throughput>
<type>DEVICE</type>
<wired100MSent>2</wired100MSent>
<wired100MThroughput>2</wired100MThroughput>
<wired10GReceived>2</wired10GReceived>
<wired10GSent>2</wired10GSent>
<wired10GThroughput>2</wired10GThroughput>
<wired10MSent>2</wired10MSent>
<wired10MThroughput>2</wired10MThroughput>
<wired1GSent>2</wired1GSent>
<wired1GThroughput>2</wired1GThroughput>
<dot11aReceived>2</dot11aReceived>
<dot11bReceived>2</dot11bReceived>
<dot11gReceived>2</dot11gReceived>
<dot11n2_4Received>2</dot11n2_4Received>
<dot11n5Received>2</dot11n5Received>
<received>2</received>
<wired100MReceived>2</wired100MReceived>
<wired10MReceived>2</wired10MReceived>
<wired1GReceived>2</wired1GReceived>
</clientTrafficsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.56.58.149/webacs/api/v4/data/ClientTraffics/15.json
{
"queryResponse" : {
"@type" : "ClientTraffics",
"@requestUrl" : "https://10.56.58.149/webacs/api/v4/data/ClientTraffics/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.56.58.149/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "clientTrafficsDTO",
"@type" : "ClientTraffics",
"@url" : "https://10.56.58.149/webacs/api/v4/data/ClientTraffics/15",
"clientTrafficsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"collectionTime" : 2,
"dot11aReceived" : 2,
"dot11aSent" : 2,
"dot11aThroughput" : 2,
"dot11acReceived" : 2,
"dot11acSent" : 2,
"dot11acThroughput" : 2,
"dot11ax2_4Received" : 2,
"dot11ax2_4Sent" : 2,
"dot11ax2_4Throughput" : 2,
"dot11ax5Received" : 2,
"dot11ax5Sent" : 2,
"dot11ax5Throughput" : 2,
"dot11bReceived" : 2,
"dot11bSent" : 2,
"dot11bThroughput" : 2,
"dot11gReceived" : 2,
"dot11gSent" : 2,
"dot11gThroughput" : 2,
"dot11n2_4Received" : 2,
"dot11n2_4Sent" : 2,
"dot11n2_4Throughput" : 2,
"dot11n5Received" : 2,
"dot11n5Sent" : 2,
"dot11n5Throughput" : 2,
"key" : "String value",
"received" : 2,
"sent" : 2,
"subkey" : "String value",
"throughput" : 2,
"type" : "DEVICE",
"wired100MReceived" : 2,
"wired100MSent" : 2,
"wired100MThroughput" : 2,
"wired10GReceived" : 2,
"wired10GSent" : 2,
"wired10GThroughput" : 2,
"wired10MReceived" : 2,
"wired10MSent" : 2,
"wired10MThroughput" : 2,
"wired1GReceived" : 2,
"wired1GSent" : 2,
"wired1GThroughput" : 2
}
} ]
}
}