PilotFoxDocs

List pages

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

Each page (or section, with group=section) with its visitors, sessions, pageviews, entries, exits, bounce rate and time on page, ranked by pageviews (or by entries or exits, with view), a page at a time (limit and offset; meta.totalCount); with goal, its converting sessions.

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

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
view?string

all pages ranked by pageviews, or the pages with entries (entry) or exits (exit) ranked by them

Default"all"
Value in"all""entry""exit"
group?string

section groups /a/b/c under /a/**

Default"page"
Value in"page""section"
search?string

Case-insensitive match on the pathname or the title

Lengthlength <= 200
goal?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
limit?integer
Range1 <= value <= 1000
Default50
offset?integer
Range0 <= value <= 100000
Default0

Response Body

OK

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/pages'
Example Response200
{  "data": [    {      "pathname": "string",      "title": "string",      "visitors": 0,      "sessions": 0,      "pageviews": 0,      "entries": 0,      "exits": 0,      "bounce_rate": 0,      "time_on_page": 0,      "conversions": 0    }  ],  "meta": {    "window": {      "from": "string",      "to": "string",      "tz": "string",      "bucket": "minute"    },    "compare": {      "from": "string",      "to": "string"    },    "totalCount": -9007199254740991,    "nextCursor": "string",    "truncated": true,    "cache": "hit"  }}