Docs/API REFERENCE/TrackFox API overview

TrackFox API overview

The v1 API exposes the analytics displayed by TrackFox: summary metrics, charts, pages, referrers, locations, platforms, custom events, realtime visitors, and Electron version adoption. Its production base URL is https://trackfox.app and all bodies are JSON.

Quick start

curl "https://trackfox.app/api/v1/metadata?websiteId=site_123&period=last30d" \
  -H "Authorization: Bearer tf_your_api_key"

API keys are scoped to one website. Create and name keys in Website settings → API, store them as secrets, and rotate or revoke them from the same page. Every request must send the matching websiteId and Authorization: Bearer <key>. CORS is enabled on v1 responses; never embed a secret key in public browser code.

An account API key instead spans every website your account can see, but is read-only (GET only). Generate one as a QR code from your account menu → Mobile App and scan it with the TrackFox mobile app to pair it — or call GET /api/v1/websites yourself to discover which websiteId values it can read.

See periods, timezones, and pagination for shared query parameters and errors for the stable error envelope. List endpoints return opaque cursors; pass nextCursor back unchanged.

Analytics endpoints

TrackFox may enforce request limits to protect service reliability. A 429 response means the client should wait and retry with exponential backoff.

Need help? Contact us for assistance.

Suggest features? We'd love your feedback