HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Top N Clients

get
https://{api-base-url}/monitoring/v1/clients/bandwidth_usage/topn

Get top N client details over a time period. You can only specify one of group, swarm_id, label, cluster_id
and stack_id parameters.
Possible error_codes 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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by group name

string

Filter by Swarm ID. Field supported for AP clients only

string

Filter by Label name

string

Filter by network name. Field supported for wireless clients only

string

Filter by Mobility Controller serial number

string

Filter by Switch stack_id

int32

Required top N clients count. Default is 5 and maximum is 100

int32

Need information from this timestamp. Timestamp is epoch in seconds. Default is current timestamp minus 3 hours

int32

Need information to this timestamp. Timestamp is epoch in seconds. Default is current timestamp

Responses

401

Unauthorized access

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago