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/HistoricalClientStats
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
bytesReceived
long
|
Number of bytes received during the session
|
bytesSent
long
|
Number of bytes sent during the session
|
collectionTime
long
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
dataRate
float
|
Reading data rate, measured in Mbps.
|
dataRetries
long
|
Number data retries during the session
|
macAddress
String
|
|
packetsReceived
long
|
Number packets received during the session
|
packetsSent
long
|
Number of packets sent during the session
|
raPacketsDropped
long
|
Number of IPv6 RA packets dropped during the session
|
|
The Received Signal Strength Indicator as detected by the access point with which the client is associated, measured in dBm.
|
rtsRetries
long
|
Number of RTS retries during the session
|
rxBytesDropped
long
|
Number of Rx bytes dropped during the session
|
rxPacketsDropped
long
|
Number of Rx packets dropped during the session
|
snr
int
|
Signal-to-noise ratio of the client session as detected by the access point with which the client is associated.
|
txBytesDropped
long
|
Number of Tx bytes dropped during the session
|
txPacketsDropped
long
|
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://localhost/webacs/api/v1/data/HistoricalClientStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalClientStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/HistoricalClientStats/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="historicalClientStatsDTO" type="HistoricalClientStats" url="https://localhost/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>
<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>
<macAddress>String value</macAddress>
</historicalClientStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/HistoricalClientStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalClientStats",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/HistoricalClientStats\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "historicalClientStatsDTO",
"@type" : "HistoricalClientStats",
"@url" : "https : \/\/localhost\/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,
"packetsReceived" : 2,
"packetsSent" : 2,
"raPacketsDropped" : 2,
"rssi" : 1,
"rtsRetries" : 2,
"rxBytesDropped" : 2,
"rxPacketsDropped" : 2,
"snr" : 1,
"txBytesDropped" : 2,
"txPacketsDropped" : 2,
"macAddress" : "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/HistoricalClientStats
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
bytesReceived
long
|
Number of bytes received during the session
|
bytesSent
long
|
Number of bytes sent during the session
|
collectionTime
long
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
dataRate
float
|
Reading data rate, measured in Mbps.
|
dataRetries
long
|
Number data retries during the session
|
macAddress
String
|
|
packetsReceived
long
|
Number packets received during the session
|
packetsSent
long
|
Number of packets sent during the session
|
raPacketsDropped
long
|
Number of IPv6 RA packets dropped during the session
|
|
The Received Signal Strength Indicator as detected by the access point with which the client is associated, measured in dBm.
|
rtsRetries
long
|
Number of RTS retries during the session
|
rxBytesDropped
long
|
Number of Rx bytes dropped during the session
|
rxPacketsDropped
long
|
Number of Rx packets dropped during the session
|
snr
int
|
Signal-to-noise ratio of the client session as detected by the access point with which the client is associated.
|
txBytesDropped
long
|
Number of Tx bytes dropped during the session
|
txPacketsDropped
long
|
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://localhost/webacs/api/v2/data/HistoricalClientStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalClientStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/HistoricalClientStats/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="historicalClientStatsDTO" type="HistoricalClientStats" url="https://localhost/webacs/api/v2/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>
<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>
<macAddress>String value</macAddress>
</historicalClientStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/HistoricalClientStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalClientStats",
"@requestUrl" : "https://localhost/webacs/api/v2/data/HistoricalClientStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "historicalClientStatsDTO",
"@type" : "HistoricalClientStats",
"@url" : "https://localhost/webacs/api/v2/data/HistoricalClientStats/15",
"historicalClientStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"bytesReceived" : 2,
"bytesSent" : 2,
"collectionTime" : 2,
"dataRate" : 3.0,
"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
}
} ]
}
}
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/HistoricalClientStats
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
bytesReceived
long
|
Number of bytes received during the session
|
bytesSent
long
|
Number of bytes sent during the session
|
collectionTime
long
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
dataRate
float
|
Reading data rate, measured in Mbps.
|
dataRetries
long
|
Number data retries during the session
|
macAddress
String
|
|
packetsReceived
long
|
Number packets received during the session
|
packetsSent
long
|
Number of packets sent during the session
|
raPacketsDropped
long
|
Number of IPv6 RA packets dropped during the session
|
|
The Received Signal Strength Indicator as detected by the access point with which the client is associated, measured in dBm.
|
rtsRetries
long
|
Number of RTS retries during the session
|
rxBytesDropped
long
|
Number of Rx bytes dropped during the session
|
rxPacketsDropped
long
|
Number of Rx packets dropped during the session
|
snr
int
|
Signal-to-noise ratio of the client session as detected by the access point with which the client is associated.
|
txBytesDropped
long
|
Number of Tx bytes dropped during the session
|
txPacketsDropped
long
|
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://localhost/webacs/api/v3/data/HistoricalClientStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalClientStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/HistoricalClientStats/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="historicalClientStatsDTO" type="HistoricalClientStats" url="https://localhost/webacs/api/v3/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>
<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>
<macAddress>String value</macAddress>
</historicalClientStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/HistoricalClientStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalClientStats",
"@requestUrl" : "https://localhost/webacs/api/v3/data/HistoricalClientStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "historicalClientStatsDTO",
"@type" : "HistoricalClientStats",
"@url" : "https://localhost/webacs/api/v3/data/HistoricalClientStats/15",
"historicalClientStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"bytesReceived" : 2,
"bytesSent" : 2,
"collectionTime" : 2,
"dataRate" : 3.0,
"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
}
} ]
}
}
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/HistoricalClientStats
Updated
Since version 4 type of macAddress attribute is MacAddress.
Response Parameters
bytesReceived
long
|
Number of bytes received during the session
|
bytesSent
long
|
Number of bytes sent during the session
|
collectionTime
long
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
dataRate
float
|
Reading data rate, measured in Mbps.
|
dataRetries
long
|
Number data retries during the session
|
macAddress
MacAddress
|
|
packetsReceived
long
|
Number packets received during the session
|
packetsSent
long
|
Number of packets sent during the session
|
raPacketsDropped
long
|
Number of IPv6 RA packets dropped during the session
|
|
The Received Signal Strength Indicator as detected by the access point with which the client is associated, measured in dBm.
|
rtsRetries
long
|
Number of RTS retries during the session
|
rxBytesDropped
long
|
Number of Rx bytes dropped during the session
|
rxPacketsDropped
long
|
Number of Rx packets dropped during the session
|
snr
int
|
Signal-to-noise ratio of the client session as detected by the access point with which the client is associated.
|
txBytesDropped
long
|
Number of Tx bytes dropped during the session
|
txPacketsDropped
long
|
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://localhost/webacs/api/v4/data/HistoricalClientStats/15
<?xml version="1.0" ?>
<queryResponse type="HistoricalClientStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/HistoricalClientStats/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="historicalClientStatsDTO" type="HistoricalClientStats" url="https://localhost/webacs/api/v4/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>
<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>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
</historicalClientStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/HistoricalClientStats/15.json
{
"queryResponse" : {
"@type" : "HistoricalClientStats",
"@requestUrl" : "https://localhost/webacs/api/v4/data/HistoricalClientStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "historicalClientStatsDTO",
"@type" : "HistoricalClientStats",
"@url" : "https://localhost/webacs/api/v4/data/HistoricalClientStats/15",
"historicalClientStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"bytesReceived" : 2,
"bytesSent" : 2,
"collectionTime" : 2,
"dataRate" : 3.0,
"dataRetries" : 2,
"macAddress" : {
"octets" : "000a959d6816"
},
"packetsReceived" : 2,
"packetsSent" : 2,
"raPacketsDropped" : 2,
"rssi" : 1,
"rtsRetries" : 2,
"rxBytesDropped" : 2,
"rxPacketsDropped" : 2,
"snr" : 1,
"txBytesDropped" : 2,
"txPacketsDropped" : 2
}
} ]
}
}