HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Gets Top N Apprf Statistics (V2 Version)

Gets Top N Applications (V2 Version)

  1. limits the tag to only app_id, app_cat, web_id and web_cat(Exclude user_role, ssid, os_type that is in V1)
  2. Enrich application information(Add tx and rx, app port, app category...)
  3. Optimized processing time
  4. Supports paging
    You can only specify one of group, site, swarm_id, serial, macaddr parameters or none for customer level.
    Possible error_codes for the error responses are
  5. 0001 - General Error
  6. 0002 - Validation Error. Out of Range value for a query parameter
  7. 0003 - Validation Error. Unsupported query combination
  8. 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 group id

string

Filter by gateway serial number

string

Filter by label id

string

Filter by site name

string

Group by one or multiple params[app_id, web_id, web_rep, app_cat, uplink_id, policy_id]

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

string

If metrics filter is uplink_id or policy_id, this will provide value for id.

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

403

Forbidden

404

Not Found

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

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