HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

Get client trends

Retrieves the client trends based on the specified group-by field and type category across a time range.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The ID of the site from which the clients are to be retrieved.

int64

Start timestamp in epoch milliseconds. Must be less than end-query-time.The interval between start-query-time and end-query-time must be ≤ 3 months. Default is end-query-time - 3 hours.
Interval between sample data points is based on the time difference:

  • Less than or equal to 3 hours → 5 min
  • Greather than 3 hours and less than or equal to 1 day → 15 min
  • Greather than 1 day and less than or equal to 1 month → 1 hour
  • Greather than 1 month and less than or equal to 3 months → 3 hours
int64

End timestamp in epoch milliseconds. Must be greater than start-query-time, and the interval between start and end must be <= 3 months. Default is current timestamp.

string
enum
Defaults to TYPE

Groups results by the specified field. If grouping by role, vlan, or wlan gives more than 5 unique names, then returns top 4 by client count and folds remaining under 'Others' name. wlan, radio, security, protocol supported for wireless clients only.

Allowed:
string
enum
Defaults to ALL

Category of clients where group-by field should be applied.

Allowed:
string

Specifies the device identifier.

Responses

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