Install guide · framework · ~3 min

Install Admaxxer on Gatsby

npm i admaxxer, call in gatsby-browser.js.

Gatsby exposes browser-only lifecycle hooks in gatsby-browser.js. The onClientEntry hook is the right place to initialize the pixel.

Steps

  1. 1 Install the package

    Add admaxxer to your project.

    bash
    npm i admaxxer
  2. 2 Initialize in gatsby-browser.js

    Add (or create) gatsby-browser.js at the project root and export an onClientEntry hook.

    gatsby-browser.js js
    import { initAdmaxxer } from 'admaxxer';
    
    export const onClientEntry = () => {
      initAdmaxxer({ websiteId: 'YOUR_WEBSITE_ID', domain: 'yourdomain.com' });
    };
  3. 3 Verify the install

    Load any public page on your site in a fresh browser tab. Within a few seconds, the Admaxxer dashboard realtime view should show the event. If nothing lands after 2 minutes, re-check the snippet is actually in the rendered HTML <head> (View Source, not just DevTools).

Verify installation

Troubleshooting

No events are showing up. What now?
Open DevTools Console and Network. Filter for script.js and /api/event. If they are blocked:csp, your Content Security Policy is blocking admaxxer.com — see /documentation/troubleshoot/csp. Also double-check that data-website-id matches the ID shown in your dashboard.
Events show up in staging but not production.
Confirm data-domain matches the production hostname exactly (no protocol, no trailing slash). Also confirm the website's Allowed Domains list in settings includes the prod domain.
My site is a single-page app — am I missing pageviews?
Use script.hash.js if you rely on location.hash routing. Otherwise the default script.js already hooks history.pushState/replaceState and tracks SPA navigations.