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

Gets Top N Web categories

get
https://{api-base-url}/apprf/v1/webcategories

Gets Top N Web categories. You can only specify one of group, swarm_id, serial, macaddr parameters or none for customer level.
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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Required top N count. Default is 5 and maximum is 500

string

Filter by group name

string

Filter by Swarm ID

string

Filter by AP serial number

string

Filter by Client MAC address e.g. 01:23:45:67:89:ab

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

ssids
array of strings

ssids to be filtered, comma seperated values (can be applied at customer/group/swarm levels)

ssids
user_role
array of strings

user to be filtered, comma seperated values (can be applied at customer/group/swarm levels)

user_role
boolean

Flag deciding if apprf data details shall be shown

Responses

401

Unauthorized

403

Forbidden

404

Not Found

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