PilotFoxDocs

List live visitors

GET
/api/v1/sites/{siteId}/live/visitors

One row per visitor seen in the last 5 minutes, most recent first: approximate location, device, referrer, current page, pageviews and times; 1,000 at most, meta.truncated when there were more. Never cached.

Requires sessions:read on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: sessions:read

Path Parameters

siteId*string

Response Body

OK

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/live/visitors'
Example Response200
{  "data": [    {      "visitor_id": "string",      "lat": 0,      "lon": 0,      "country": "string",      "city": "string",      "device_type": "string",      "os": "string",      "browser": "string",      "referrer_domain": "string",      "pathname": "string",      "pageviews": 0,      "started_at": "string",      "last_seen_at": "string"    }  ],  "meta": {    "window": {      "from": "string",      "to": "string",      "tz": "string",      "bucket": "minute"    },    "compare": {      "from": "string",      "to": "string"    },    "totalCount": -9007199254740991,    "nextCursor": "string",    "truncated": true,    "cache": "hit"  }}