Install on Gatsby

See what visitors do on your Gatsby site.

Add the Cuttl Tag to every page’s head in gatsby-ssr.js. Route changes count as page views.

Add Cuttl to gatsby-ssr.js

  1. Sign in to Cuttl, or create a free account. Add your site with its domain. Open the site’s Install tab and copy the Cuttl Tag. It starts with <!-- Start Cuttl -->. You need the code between <script> and </script>.
  2. In your site’s root folder, open gatsby-ssr.js (create it if it isn’t there) and add:
    gatsby-ssr.js
    // gatsby-ssr.js
    const React = require("react");
    
    const cuttl = String.raw`/* paste the code from between <script> and </script> here */`;
    
    exports.onRenderBody = ({ setHeadComponents }) => {
      setHeadComponents([
        <script key="cuttl" dangerouslySetInnerHTML={{ __html: cuttl }} />,
      ]);
    };
  3. Build and deploy.
  4. In Cuttl, turn on Journey Insights for heatmaps and recordings, or Web Experiments for A/B tests. Admins can do it on the product’s page or in Settings → Plan & usage. A new workspace starts with both off, and until one is on, Cuttl keeps nothing from your site.

Check it works

  1. Open any page of your live site in a browser.
  2. In Cuttl, open the site’s Install tab. It shows when data last arrived, usually within a minute.
  3. Nothing yet? View the live page’s source and search for app.cuttl.io to check the Cuttl Tag is there. Then check that the site’s domain in Cuttl matches the address in your browser.

Check on your deployed site. Cuttl only takes data from your site’s domain, so pages on localhost won’t show up.

Good to know

  • Use gatsby-ssr.js, not gatsby-browser.js. Browser code runs after the page appears, so A/B tests could flash the original version.
  • setHeadComponents keeps what other plugins add to the head.
  • Gatsby’s client-side navigation needs no setup: each route change counts as a page view.
  • To leave out your own sessions, open any page of your site once with ?cuttl_ignore=1 at the end of the address.
Questions

Gatsby questions

Is there a Gatsby plugin?

No. The Cuttl Tag in gatsby-ssr.js is all you need.

Will it slow my site down?

No. The Cuttl Tag is under 1.7 KB and loads the rest in the background, so it never blocks the page.

See where visitors get stuck.

Free for one site. Add the Cuttl Tag, turn on Journey Insights, and your first sessions show up in Cuttl.