v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Clients

Get Wireless Client Mobility Details

This API endpoint retrieves wireless client mobility details.

get/network-monitoring/v1/clients/{mac-address}/mobility-trail

Path parameters

mac-addressstring const required

Example:c8:b5:ad:c3:b2:04

MAC address of the Wireless Client to be queried

Query parameters

site-idstring const

Example:12345678

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

site-namestring const

Example:site_name1

The name of the site from which the clients mobility details are to be retrieved.

start-atstring

Example:2025-07-10T08:09:17.419Z

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.

end-atstring

Example:2025-07-10T08:11:17.419Z

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.

filterstring

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.

Field	Operators
wlanName	eq and in
radioBand	eq 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:

Field	Applicable Terms
wlanName	string
radioBand	["2.4 GHz", "5 GHz", "6 GHz"]

sortstring const

Example:occurredAt ASC

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

nextstring

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

limitinteger

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

Response

Response schema for getting client mobility details

countinteger required

The number of mobility events after filtering for a client

totalinteger

Total number of events for a client

nextstring

Specifies the pagination cursor for the next page of resources. null if there are no further pages.

Example response

{
  "items": [
    {
      "occurredAt": "2025-07-10T08:09:17.419Z",
      "roamTime": "168",
      "wlanName": "wlan-00001",
      "sourceAp": "QNRR000002",
      "destinationAp": "QNRR000001",
      "fromChannel": "1",
      "toChannel": "50",
      "fromBssid": "32:44:3a:31:44:3a",
      "toBssid": "dc:0b:8e:d5:d0:00",
      "rssi": "-42",
      "radioBand": "5 GHz",
      "roamProtocol": "11r",
      "type": "network-monitoring/client-monitoring",
      "id": "c8:b5:ad:c3:b2:04"
    }
  ]
}