Quickstart
From sign-up to the first tracked visit: create an account, add a site, install the script and verify it.
This takes a few minutes and needs access to the HTML (or the root layout) of the site you want to track.
Create an account
Sign up with your email address, then open the confirmation link PilotFox emails you; it signs you in. Open it in the browser you signed up in to keep the password you chose: opened in another browser or on another device, it signs you in without a password, and you choose one with Forgot password on the sign-in page.
- A new account comes with its own organization, and you are its owner.
- If someone invited you, open the link in their invitation email instead: you sign up (or sign in) there and join their organization, without one of your own.
- Where the instance has Google sign-in configured, Continue with Google works too.
- Two-factor authentication with an authenticator app is available in your account settings.
On a self-hosted instance, sign-up may be invite-only; see Configuration.
Add a site
An owner or admin opens the Sites page, chooses Add site and enters a name, the domain the site runs on (host only,
for example example.com), its time zone and whether it is a website or an app. PilotFox gives the site a public id,
the SITE_ID of these docs.
Install the script
Put the tag from Site settings → Tracking code in the <head> of every page:
<script defer src="https://pilotfox.app/api/s.js" data-site="SITE_ID"></script>In a single-page app, the root layout or document template is enough: route changes are counted for you. The options, the Content Security Policy and the details are in Install the script. Copy AI prompt on the same page gives a coding assistant everything it needs to do this for you.
Verify the installation
- Verify installation (Site settings → Tracking code, and the last step of adding a site) loads your site's home page and looks for the tag with your site's id.
- Then visit your site in another tab and open the site's dashboard: the Online figure counts visitors seen in the last five minutes, and the Realtime view shows the visit with its page, source and location.
- In your browser's developer tools, the Network tab shows a
POSTto/api/eanswered204for each pageview.
Nothing arrives? See Troubleshooting.
Invite your team
In Organization settings → Members, an owner or admin invites people by email with a role, optionally limited to some sites.
Next steps
Custom events and identify
Send signups, purchases and other actions, and link visits to signed-in users.
Keep your own visits out
?pilotfox_ignore=true, exclusions and the bot filter.
Revenue
Connect Stripe, Dodo Payments or Polar and see revenue by source.
REST API
Read your reports and manage sites with an API key.