Top N Clients
GET {{base_url}}/monitoring/v1/clients/bandwidth_usage/topn?group=<string>&swarm_id=<string>&label=<string>&network=<string>&cluster_id=<string>&stack_id=<string>&count=<integer>&from_timestamp=<integer>&to_timestamp=<integer>
Get top N client details over a time period. You can only specify one of group, swarmid, label, clusterid and stackid parameters. Possible errorcodes for the error responses are 1. 0001 - General Error. 2. 0002 - Validation Error. Out of Range value for a query parameter. 3. 0003 - Validation Error. Unsupported query combination
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
group | string | Filter by group name | |
swarm_id | string | Filter by Swarm ID. Field supported for AP clients only | |
label | string | Filter by Label name | |
network | string | Filter by network name. Field supported for wireless clients only | |
cluster_id | string | Filter by Mobility Controller serial number | |
stack_id | string | Filter by Switch stack_id | |
count | string | Required top N clients count. Default is 5 and maximum is 100 | |
from_timestamp | string | Need information from this timestamp. Timestamp is epoch in seconds. Default is current timestamp minus 3 hours | |
to_timestamp | string | Need information to this timestamp. Timestamp is epoch in seconds. Default is current timestamp |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"clients":[{"macaddr":"\u003cstring\u003e","name":"\u003cstring\u003e","rx_data_bytes":"\u003cnumber\u003e","tx_data_bytes":"\u003cnumber\u003e"},{"macaddr":"\u003cstring\u003e","name":"\u003cstring\u003e","rx_data_bytes":"\u003cnumber\u003e","tx_data_bytes":"\u003cnumber\u003e"}],"count":"\u003cinteger\u003e"}