PilotFoxDocs

List events

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

The window's raw events (web vitals aside), newest first, a page at a time (meta.nextCursor); or, with since, up to 500 of the events since then (24 hours back at most), for a live feed.

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

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

Query Parameters

start?string
end?string
last?string
all?"true"
Value in"true"
tz?string
bucket?string
Value in"minute""5m""15m""hour""day""week""month""year"
filters?string
Lengthlength <= 64000
segment?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
since?string

Realtime tail: events in [since, now), at most 24 hours back; no window keys, no cursor

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
cursor?string

meta.nextCursor of the previous page

limit?integer

List mode; a tail returns up to 500 rows

Range1 <= value <= 500
Default50

Response Body

OK

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/events'
Example Response200
{  "data": [    {      "ts": "string",      "type": "string",      "event_name": "string",      "session_id": "string",      "visitor_id": "string",      "user_id": "string",      "hostname": "string",      "pathname": "string",      "querystring": "string",      "page_title": "string",      "referrer": "string",      "channel": "string",      "country": "string",      "region": "string",      "city": "string",      "browser": "string",      "os": "string",      "device_type": "string",      "props": {        "property1": "string",        "property2": "string"      }    }  ],  "meta": {    "window": {      "from": "string",      "to": "string",      "tz": "string",      "bucket": "minute"    },    "compare": {      "from": "string",      "to": "string"    },    "totalCount": -9007199254740991,    "nextCursor": "string",    "truncated": true,    "cache": "hit"  }}