Since Product Version: 3.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v2/op/statisticsService/clients/distributions/{distribution}Request Parameters
Attribute | Source | Description |
---|---|---|
distribution String |
path |
RequiredThe distribution name for which the data need to be fetched. |
device String |
query |
OptionalThe device name or ip address to which the clients belong. Use all for all devices. It is used for Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type distributions. It cannot be used together with autoAp, site and siteType filter parameters for Client Traffics by Network, Client Counts by Wireless/Wired. |
autoAp String |
query |
OptionalThe autonomous AP name or ip address to which the clients belong. Use all for all autonomous APs. It is used for Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type distributions. It cannot be used together with device, site and siteType filter parameters for Client Traffics by Network, Client Counts by Wireless/Wired. |
ssid String |
query |
OptionalThe SSID to which the clients associate with. Use all for all SSIDs. It is used for Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type distributions. |
site String |
query |
OptionalThe name of site to which the clients belong. Site examples : CampusA, CampusB/bldg1, CampusC/bldg2/floor2, CampusA/outdoorArea1, Unassigned. It is used for AP Client Counts, Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type, Client Counts by SSID, Client Counts by Switch, Client Counts by Wireless Speed, Client Counts by Wired Speed distributions. It cannot be used together with device and autoAp filter parameters for Client Traffics by Network, Client Counts by Wireless/Wired. |
siteType String |
query |
OptionalThe site type. Valid values : floor, outdoor, all. Default is all. It is used for AP Client Counts, Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type, Client Counts by SSID, Client Counts by Switch, Client Counts by Wireless Speed, Client Counts by Wired Speed distributions. |
clientType String |
query |
OptionalThe client type. Valid values : wireless, wired, all. Default is all. It is used for Client Traffics by Network, Client Counts by Wireless/Wired, Client Counts by Protocol, Client Counts by EAP Type, Count Counts by Authentication Type distributions. |
clientState String |
query |
OptionalClient association and authentication state. Valid values : associated, authenticated, all. Default is all. It is used for Client Counts by Wireless/Wired distributions. |
direction String |
query |
OptionalTraffic direction. Valid values : upstream, downstream, all. Default is all. It is used for Client Traffic by Network distributions. |
timeInterval Integer |
query |
OptionalSpecifies the range of time (in hours). This field can contain values like 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. By default is 1 hour if neither timeInterval nor the parameters startTime and endTime are provided. It is used for time series distributions. |
startTime Long |
query |
OptionalSpecifies the start time in seconds. The timeInterval parameter overrides this parameter. It is used for time series distributions. |
endTime Long |
query |
OptionalSpecifies the end time in seconds. The timeInterval parameter overrides this parameter. It is used for time series distributions. |
firstResult Integer |
header |
OptionalSpecifies index of the first result. |
maxResults Integer |
header |
OptionalSpecifies maximum results to return. |
sort String |
query |
OptionalSpecifies the sort order. Valid values : apName, mapLocation, or total for Client Counts by AP distribution; time for Client Counts by Posture Status, Client Counts by Wireless/Wired, Client Traffic by Network distributions; count for Client Counts by Protocol, Client Counts by EAP Type, Client Counts by Authentication Type, Client Counts by Wireless Speed, Client Counts by Wired Speed distributions; count, ssid for Client Counts by SSID distribution; count, name for Client Counts by Switch distribution. |
Response Parameters
Attribute | Description |
---|---|
currentDateTime String |
Current timestamp |
description String |
Metric description |
metricName String |
Metric name |
Metric data list |
|
resourceName String |
Resource name |
Properties of X values |
|
Properties of Y values |
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 Response Payload
https://localhost/webacs/api/v2/op/statisticsService/clients/distributions/{distribution}?timeInterval=2&site=MyCampus%2Fbldg10%2Ffloor2
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/statisticsService/clients/distributions/{distribution}?timeInterval=2&amp;site=MyCampus%2Fbldg10%2Ffloor2
" rootUrl="https://localhost/webacs/api/v2/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<YValues>
<YValues>15.0</YValues>
</YValues>
</metricRows>
</metricRows>
<resourceName>String value</resourceName>
<XValueProperty>
<label>String value</label>
<unit>NUMBER</unit>
</XValueProperty>
<YValueProperty>
<YValueProperty>
<label>String value</label>
<maxVal>4.0</maxVal>
<minVal>4.0</minVal>
<unit>NUMBER</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/statisticsService/clients/distributions/{distribution}.json?timeInterval=2&site=MyCampus%2Fbldg10%2Ffloor2
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/statisticsService/clients/distributions/{distribution}?timeInterval=2&site=MyCampus%2Fbldg10%2Ffloor2\n\t\t\t\t ",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YValues" : {
"yvalues" : [ 15.0 ]
},
"issue" : "String value"
} ]
},
"resourceName" : "String value"
} ]
}
}