Get Started
Documentation menu

Install on Gatsby

Add Open Analytics to a Gatsby site: where the snippet goes and how to verify it.

The short way

From your project folder, let the CLI detect Gatsby and place the snippet itself:

terminal
npx getopen init

It asks for your tracking key (dashboard, your site, Settings, Installation), writes the tag, and prints which file it changed. Prefer to do it by hand? The steps below are what it does.

Manual steps

1. Use the SSR API to add the script to every page's head.

gatsby-ssr.js
import React from "react";

export const onRenderBody = ({ setHeadComponents }) => {
  setHeadComponents([
    <script
      key="open-analytics"
      async
      src="https://c.getopen.so/oa.js"
      data-key="YOUR_TRACKING_KEY"
      data-collector="https://c.getopen.so"
    />,
  ]);
};

2. Deploy (or run your dev server) and open the site once. The realtime view in your dashboard shows the visit within seconds; historical charts fill moments later.

Next

Route changes in a single-page app are tracked automatically, and the snippet never needs editing for updates. From here: custom events for the actions you care about, or script options for test mode and the privacy attributes.