Connected Clients

A compact summary of today's connected-client counts grouped by gateway — one row per gateway with the total number of unique clients seen so far today. For per-client records (MAC, IP, hostname), see Clients.

---

Client count summary GET /v1/connected_clients

Returns today's connected client count per gateway, ordered by client count descending.

Query parameters

• namestring

  Case-insensitive substring match on the gateway's name (deviceName) — name=site a returns only gateways whose name contains "site a". A gateway with no name never matches.

• workspaceIdstring

  Scope the response to a single workspace. Must be one returned by GET /v1/workspaces — the token's own workspace or a child. Omit to include every workspace your token can reach. An id outside your token's set returns 403.

Response object

• siteCodestring

  Site identifier for the gateway.

• deviceNamestring

  Display name of the gateway or access point.

• gatewayIdstring

  Unique identifier of the gateway device. Matches gatewayId on /v1/clients and gatewayId on /v1/devices.

• clientCountinteger

  Number of unique clients seen today on this gateway.

• lastUpdatedAttimestamp

  When the count was last refreshed.

GET/v1/connected_clients

cURL

curl "https://polaris.revlv.com/v1/connected_clients?name=Site%20A" \
  -H "Authorization: Bearer {token}"

JavaScript

const res = await fetch('https://polaris.revlv.com/v1/connected_clients', {
  headers: { 'Authorization': 'Bearer {token}' },
});
const { data } = await res.json();

Go

req, _ := http.NewRequest("GET", "https://polaris.revlv.com/v1/connected_clients", nil)
req.Header.Add("Authorization", "Bearer {token}")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))

PHP

$response = $client->get('https://polaris.revlv.com/v1/connected_clients', [
  'headers' => ['Authorization' => 'Bearer {token}'],
]);
echo $response->getBody();

Response

{
  "data": [
    {
      "siteCode": "REV-001-001",
      "deviceName": "Site A Gateway",
      "gatewayId": "d1e2f3a4-b5c6-7890-abcd-ef1234567890",
      "clientCount": 14,
      "lastUpdatedAt": "2026-05-02T10:25:00Z"
    },
    {
      "siteCode": "REV-001-002",
      "deviceName": "Site B Gateway",
      "gatewayId": "e2f3a4b5-c6d7-8901-bcde-f12345678901",
      "clientCount": 7,
      "lastUpdatedAt": "2026-05-02T10:25:00Z"
    }
  ]
}