PilotFoxDocs

Get the organization overview

GET
/api/v1/orgs/{orgId}/overview

One card per site the caller sees, most visitors first, with its visitors, sessions and a visitors sparkline, and the totals over those sites (each visitor counted once). Window keys only (no filters or comparison); days and buckets are in UTC unless tz names another time zone.

Requires analytics:read in the organization (an API key, or a signed-in member's role; a member restricted to some sites holds a viewer's permissions here). API keys limited to some sites: allowed, and see only those sites. 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: analytics:read

Path Parameters

orgId*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"

Response Body

OK

application/json
  1. response
data*
meta*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/orgs/string/overview'
Example Response200
{  "data": {    "sites": [      {        "id": "string",        "name": "string",        "domain": "string",        "visitors": 0,        "sessions": 0,        "series": [          {            "t": "string",            "visitors": 0          }        ]      }    ],    "totals": {      "visitors": 0,      "sessions": 0    }  },  "meta": {    "window": {      "from": "string",      "to": "string",      "tz": "string",      "bucket": "minute"    },    "compare": {      "from": "string",      "to": "string"    },    "totalCount": -9007199254740991,    "nextCursor": "string",    "truncated": true,    "cache": "hit"  }}