Get the retention report
Cohorts of new users by their first active day, week or month (unit) in the window, and the share of each cohort active again 0, 1, 2… periods later. Needs a bounded window (400 for all=true).
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.
x-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
siteId*stringstart?stringend?stringlast?stringall?"true""true"tz?stringbucket?string"minute""5m""15m""hour""day""week""month""year"filters?stringlength <= 64000segment?string^([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)$uuidunit?string"week""day""week""month"periods?integerOffset columns; default one per cohort
1 <= value <= 9007199254740991lookback_days?integerUsers seen this long before the window are not new
0 <= value <= 36590OK
application/json- response
data*meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/retention'{ "data": { "unit": "day", "periods": 0, "partialFirst": true, "partialLast": true, "cohorts": [ { "start": "string", "size": 0, "counts": [ 0 ], "rates": [ 0 ] } ] }, "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}