v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Location

Get locations of Wi-Fi clients

This API provides Wi-Fi client locations using a variety of query options. Please use either latest-location-per-client or latest-connected-client-mac query parameters. For details please refer to descriptions of corresponding parameters.

get/network-services/v1/wifi-clients-locations

Query parameters

filterstring const

This is required parameter if latest-location-per-client parameter is used. 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
siteId (mandatory)	eq and in
buildingId	eq and in
floorId	eq and in
associated	eq
connected	eq

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.

Note: Provide boolean values (true/false) in lowercase.

start-atstring date-time

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

Retrieve data starting at the specified timestamp. Provided in RFC 3339 format. Example: 2023-01-01T23:10:41.123Z. If no timestamp is provided, all data will be considered.

limitinteger

Specifies the number of results to be returned. (Default: 100)

Example:20

Denotes the maximum number of clients returned in the response. (Default: 100)

offsetinteger

Specifies the zero-based resource offset to start the response from. (Default: 0)

Example:1

Specifies the zero-based resource offset to start the page from. Default: 0

latest-location-per-clientinteger

The number of latest locations per client.

Example:1

Provides a list of latest client locations. Only the value of 1 is supported for the moment. It is mutually exclusive from parameter latest-connected-client-mac.

latest-connected-client-macstring mac

MAC address for the client

Example:11:22:33:44:55:66

Provides the latest location information for a specific client that is connected and associated. Do not provide filter, offset and limit when using this query parameter. It is mutually exclusive from parameter latest-location-per-client.

Response

Response returned with a list of Wifi client locations and the associated page information. Users can request the next page based on the information returned.

offsetinteger

Specifies the offset of the returned page.

countinteger required

The number of objects returned in the current list.

totalinteger

The total number of objects contained in the datastore.

Example response

{
  "items": [
    {
      "type": "network-services/wifi-client-locations",
      "id": "11:22:33:44:55:66-1234567890123",
      "siteId": "1033566193",
      "buildingId": "cfd5dfe0-1476-49b1-ac37-6576801d1124",
      "floorId": "9f50f534-c117-48f8-9bf8-a6594e1f49a5",
      "macAddress": "11:22:33:44:55:66",
      "hashedMacAddress": "43ddc7ed75eb039db1fec4839c0e33d21bfb21e1",
      "associated": true,
      "associatedBssid": "11:22:33:44:55:77",
      "cartesianCoordinates": {
        "xInMetre": 19.12,
        "yInMetre": 74.9
      },
      "geoCoordinates": {
        "latitude": 45.687416,
        "longitude": -73.622016
      },
      "clientClassification": "Unknown",
      "accuracy": 25.2,
      "numOfReportingAps": 3,
      "connected": true,
      "createdAt": "2023-02-14T12:23:00.000Z"
    }
  ],
  "count": 100,
  "total": 200
}