PilotFox developer documentation
Install the tracking script, send events, read your analytics over the REST API or MCP, and run PilotFox on your own server.
- Getting startedHow PilotFox is organised: organizations, sites, members and their roles.
- TrackingHow the PilotFox tracking script works, what it records and the global object it defines.
- REST APIThe PilotFox REST API: base URL, request and response format, ids, and the OpenAPI document behind the reference.
- Server-side ingestSend events and identify users from your own server with an API key that has the ingest:write permission.
- MCP serverLet AI assistants and agents read your analytics through PilotFox's Model Context Protocol server at /api/mcp.
- RevenueConnect a payment provider with a read-only key, see which payments count, and read revenue and subscription metrics.
- AffiliatesTrack ?ref= referral links, register affiliates with a commission rate and credit revenue to the last affiliate a buyer came through.
- Search ConsoleConnect a Google account, link a site to its Search Console property, and read clicks, impressions, queries and pages.
- NotificationsNew-sale notifications by email, Slack or Discord, and weekly or monthly email reports.
- PrivacyHow PilotFox counts visitors without cookies and what it does with IP addresses.
- Self-hostingRun PilotFox yourself: the one compose file, what runs where, and what is exposed to the internet.
- FAQAnswers about accounts, tracking, revenue, data, the API and self-hosting.