Fetches the distribution data for clients
Since Product Version: 3.2
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/op/statisticsService/clients/distributions/{distribution}Unmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
distribution String |
path |
Required The distribution name for which the data need to be fetched. |
device String |
query |
Optional The 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 |
Optional The 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 |
Optional The 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 |
Optional The 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 |
Optional The 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 |
Optional The 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 |
Optional Client 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 |
Optional Traffic direction. Valid values : upstream, downstream, all. Default is all. It is used for Client Traffic by Network distributions. |
timeInterval Integer |
query |
Optional Specifies 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 |
Optional Specifies the start time in seconds. The timeInterval parameter overrides this parameter. It is used for time series distributions. |
endTime Long |
query |
Optional Specifies the end time in seconds. The timeInterval parameter overrides this parameter. It is used for time series distributions. |
firstResult Integer |
header |
Optional Specifies index of the first result. |
maxResults Integer |
header |
Optional Specifies maximum results to return. |
sort String |
query |
Optional Specifies 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://10.64.80.159/webacs/api/v4/op/statisticsService/clients/distributions/{distribution}?timeInterval=2&site=MyCampus%2Fbldg10%2Ffloor2
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.80.159/webacs/api/v4/op/statisticsService/clients/distributions/{distribution}?timeInterval=2&amp;site=MyCampus%2Fbldg10%2Ffloor2
" rootUrl="https://10.64.80.159/webacs/api/v4/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.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>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v4/op/statisticsService/clients/distributions/{distribution}.json?timeInterval=2&site=MyCampus%2Fbldg10%2Ffloor2
{
"mgmtResponse" : {
"@requestUrl" : "https://10.64.80.159/webacs/api/v4/op/statisticsService/clients/distributions/{distribution}?timeInterval=2&site=MyCampus%2Fbldg10%2Ffloor2\n\t\t\t\t\t",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v4/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
}, {
"label" : "Another string value",
"maxVal" : 14.0,
"minVal" : 14.0,
"unit" : "STRING"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "String value"
}, {
"XValue" : "Another string value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "Another string value"
} ]
},
"resourceName" : "String value"
} ]
}
}