PilotFoxDocs

List an error's occurrences

GET
/api/v1/sites/{siteId}/errors/{fingerprint}/occurrences

Each occurrence of one error, newest first, with its session and page, a page at a time (meta.nextCursor).

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
fingerprint*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
cursor?string

meta.nextCursor of the previous page

limit?integer
Range1 <= value <= 200
Default50

Response Body

OK

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/errors/string/occurrences'
Example Response200
{  "data": [    {      "ts": "string",      "session_id": "string",      "visitor_id": "string",      "user_id": "string",      "pathname": "string",      "browser": "string",      "browser_version": "string",      "os": "string",      "device_type": "string",      "country": "string",      "message": "string",      "stack": "string",      "file": "string",      "line": 0,      "col": 0    }  ],  "meta": {    "window": {      "from": "string",      "to": "string",      "tz": "string",      "bucket": "minute"    },    "compare": {      "from": "string",      "to": "string"    },    "totalCount": -9007199254740991,    "nextCursor": "string",    "truncated": true,    "cache": "hit"  }}