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

AP Bandwidth Usage

get
https://{api-base-url}/monitoring/v3/aps/bandwidth_usage

Get the average bandwidth usage for access points over a time period. You can only specify one of group, swarm_id, label,
serial, cluster_id, site 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
  4. 0004 - Validation Error. Invalid value for a query parameter
  5. 0005 - Validation Error. Missing required parameter.
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 Site name

string

Filter by AP serial

string

Filter by Mobility Controller serial number

string

Filter by interval (5minutes or 1hour or 1day or 1week).

string

Filter by band (2.4, 5 or 6). Valid only when serial parameter is specified.

integer

Filter by radio_number (0, 1 or 2). Valid only when serial parameter is specified.

int32

Filter by ethernet interface index. Valid only when serial parameter is specified. Valid range is 0-3.

string

Filter by network name. Valid only when serial parameter is specified.

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