HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

Get Clients Trend

Retrieves the clients trend 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

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

string

The name of the site for which clients trend are to be retrieved.

string

Start timestamp in RFC 3339 date-time string. Must be less than end-at. The interval between start-at and end-at must be ≤ 1 month. Default is end-at - 3 hours.
Interval between sample data points is based on the time difference:

  • Less than or equal to 1 day → 5 min
  • Greater than 1 day and less than or equal to 1 month → 3 hours
string

End timestamp in RFC 3339 date-time string. Must be greater than start-at, and the interval between start and end must be <= 1 month. 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