PilotFoxDocs

Get the live summary

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

Visitors seen in the last 5 minutes (null when presence cannot be read) and, over the last 30 minutes, pageviews per minute and the top 10 pages (by pageviews), referrers and countries (by visitors). Never cached.

Requires analytics:read on the site (an API key, or a signed-in member's role). Share links: allowed, with the analytics:read scope. Public sites: open to everyone, no credential needed.

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: analytics:read

Path Parameters

siteId*string

Response Body

OK

application/json
  1. response
data*
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/live'
Example Response200
{  "data": {    "visitors": 0,    "pageviews_last_30m": [      {        "minute": "string",        "count": 0      }    ],    "top_pages": [      {        "pathname": "string",        "pageviews": 0      }    ],    "top_referrers": [      {        "referrer_domain": "string",        "visitors": 0      }    ],    "countries": [      {        "country": "string",        "visitors": 0      }    ]  },  "meta": {    "window": {      "from": "string",      "to": "string",      "tz": "string",      "bucket": "minute"    },    "compare": {      "from": "string",      "to": "string"    },    "totalCount": -9007199254740991,    "nextCursor": "string",    "truncated": true,    "cache": "hit"  }}