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

WLAN Network Bandwidth usage

get
https://{api-base-url}/monitoring/v2/networks/bandwidth_usage

Get WLAN network bandwidth usage over a time period. You can only specify one of group, swarm_id, label, 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. 0005 - Validation Error. Missing required parameter.
Query Params
string
required

Filter by network name

string

Filter by group name

string

Filter by Swarm ID. Field supported for AP clients only

string

Filter by Label name

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

string

Filter by Site name

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
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 years ago