HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

Get wireless client mobility details

This API endpoint retrieves wireless client mobility details.

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

MAC address of the Wireless Client to be queried

Query Params
string
required

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

string
length ≤ 13

Specifies the start timestamp in epoch milliseconds for client mobility details. Defaults to last 3hrs. Can be set up to 30 days in the past.

string
length ≤ 13

Specifies the end timestamp in epoch milliseconds for client mobility details. Will be set to current timestamp even if provided.

string

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

FieldOperators
WLANeq and in
radioeq and in

The operators are implemented as follows:

  • eq: Only values exactly matching the given value are returned.
  • in: Only values present in the given list are returned.

List of applicable filters for field and terms:

FieldApplicable Terms
WLANstring
radio["2.4 GHz", "5 GHz", "6 GHz"]
string
length ≤ 256

Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported field is occurred.
. Default sorting for occurred is DESC

integer
≥ 1
Defaults to 1

Specifies the pagination cursor for the next page of resources. Minimum value is 1

integer
1 to 100
Defaults to 20

Maximum number of client mobility details to be retrieved. Allowed range is 1 to 100.

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