PilotFoxDocs

Identify a visitor from a server

POST
/api/v1/ingest/identify

Links a visitor, named by anonymous_id or by the ip and user_agent its browser events carry (400 without either), to the user id uid, with optional traits; an email trait sent here can link payments to the user. 404 for a site the key cannot write to; 204 also when the site's exclusions or bot rules drop it.

Requires an API key holding ingest:write. Session cookies and 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: ingest:write

Request Body

application/json
  1. body
site*string
Length1 <= length
uid*string
traits?unknown
bs?number
bm?number
ip?string
user_agent?string
anonymous_id?string

Response Body

No Content

Example Request
curl -X POST 'https://pilotfox.app/api/v1/ingest/identify' \  -H 'Content-Type: application/json' \  -d '{  "site": "string",  "uid": "string"}'
Example Response204
Empty