# gatsby-plugin-google-analytics > Gatsby plugin to add google analytics onto a site Latest version **5.16.0** (published 2026-01-26) · MIT license · 0 weekly downloads ## Install ```sh npm install gatsby-plugin-google-analytics pnpm add gatsby-plugin-google-analytics yarn add gatsby-plugin-google-analytics bun add gatsby-plugin-google-analytics ``` ## Health **Score 65/100 (B)** — status: stable. Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular. Warnings: low downloads; no esm support. ## Facts | | | |---|---| | Version | 5.16.0 | | Published | 2026-01-26 | | First published | 2017-01-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=18.0.0 <26 | | Dependencies | 3 | | Unpacked size | 74.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 55940 | | Author | Kyle Mathews | | Maintainers | pieh, kathmbeck, serhalp-netlify, mlgualtieri-gatsby, tylerbarnes | | Keywords | gatsby, gatsby-plugin, google analytics | ## Links - npm: https://www.npmjs.com/package/gatsby-plugin-google-analytics - Repository: https://github.com/gatsbyjs/gatsby - Homepage: https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-google-analytics#readme - Issues: https://github.com/gatsbyjs/gatsby/issues - npm.io page: https://npm.io/package/gatsby-plugin-google-analytics ## Dependencies (3) - [minimatch](https://npm.io/package/minimatch.md) ^3.1.2 - [web-vitals](https://npm.io/package/web-vitals.md) ^1.1.2 - [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.20.13 ## Recent versions - 5.16.0 (latest) — 2026-01-26 - 5.17.0-next.0 (next) — 2025-11-27 - 5.18.0-react19.1 (react19) — 2025-11-26 - 3.15.0 (latest-v3) — 2022-12-07 - 4.25.0 (latest-v4) — 2022-12-07 - 5.0.0-alpha-drupal-proxyurl.14 (drupal-proxyurl) — 2022-11-22 - 4.14.0-alpha-transformer-json.26 (alpha-transformer-json) — 2022-10-12 - 5.0.0-alpha-v5.d20221012t101120.57 (alpha-v5) — 2022-10-12 - 4.23.0-alpha-a5-peer.70 (alpha-a5-peer) — 2022-09-14 - 4.23.0-alpha-preview-gh-api.26 (preview-gh-api) — 2022-09-08 - 4.23.0-alpha-9689ff.25 (alpha-9689ff) — 2022-08-31 - 4.18.0-alpha-drupal-self-reference.18 (drupal-self-reference) — 2022-07-19 - 4.15.0-alpha-wp-image-cdn-auth.48 (wp-image-cdn-auth) — 2022-05-20 - 4.8.0-alpha-image-service.24 (image-service) — 2022-02-10 - 4.6.0-alpha-ts-jit.60 (alpha-ts-jit) — 2022-01-21 - … 558 more at https://npm.io/package/gatsby-plugin-google-analytics/versions ## README # gatsby-plugin-google-analytics Easily add Google Analytics to your Gatsby site. ## Deprecation Notice This plugin uses Google's `analytics.js` file under the hood. Google has a [guide recommending users upgrade to `gtag.js` instead](https://developers.google.com/analytics/devguides/collection/upgrade/analyticsjs). There is another plugin [`gatsby-plugin-google-gtag`](https://gatsbyjs.com/plugins/gatsby-plugin-google-gtag/) which uses `gtag.js` and we recommend it. ## Install ```shell npm install gatsby-plugin-google-analytics ``` ## How to use ```javascript // In your gatsby-config.js module.exports = { plugins: [ { resolve: `gatsby-plugin-google-analytics`, options: { // The property ID; the tracking code won't be generated without it trackingId: "YOUR_GOOGLE_ANALYTICS_TRACKING_ID", // Defines where to place the tracking script - `true` in the head and `false` in the body head: false, // Setting this parameter is optional anonymize: true, // Setting this parameter is also optional respectDNT: true, // Avoids sending pageview hits from custom paths exclude: ["/preview/**", "/do-not-track/me/too/"], // Delays sending pageview hits on route update (in milliseconds) pageTransitionDelay: 0, // Enables Google Optimize using your container Id optimizeId: "YOUR_GOOGLE_OPTIMIZE_TRACKING_ID", // Enables Google Optimize Experiment ID experimentId: "YOUR_GOOGLE_EXPERIMENT_ID", // Set Variation ID. 0 for original 1,2,3.... variationId: "YOUR_GOOGLE_OPTIMIZE_VARIATION_ID", // Defers execution of google analytics script after page load defer: false, // Any additional optional fields sampleRate: 5, siteSpeedSampleRate: 10, cookieDomain: "example.com", // defaults to false enableWebVitalsTracking: true, }, }, ], } ``` See below for the complete list of [optional fields](#optional-fields). Note that this plugin is disabled while running `gatsby develop`. This way, actions are not tracked while you are still developing your project. Once you run `gatsby build` the plugin is enabled. Test it with `gatsby serve`. ## `` component To make it easy to track clicks on outbound links in Google Analytics, the plugin provides a component. To use it, simply import it and use it like you would the `` element e.g. ```jsx import React from "react" import { OutboundLink } from "gatsby-plugin-google-analytics" const Component = () => (
Visit the Google Analytics plugin page!
) export default Component ``` ## Options ### `trackingId` Here you place your Google Analytics tracking id. ### `head` Where do you want to place the GA script? By putting `head` to `true`, it will be placed in the "<head>" of your website. By setting it to `false`, it will be placed in the "<body>". The default value resolves to `false`. ### `anonymize` Some countries (such as Germany) require you to use the [\_anonymizeIP](https://support.google.com/analytics/answer/2763052) function for Google Analytics. Otherwise you are not allowed to use it. The option adds two blocks to the code: ```javascript function gaOptout(){document.cookie=disableStr+'=true; expires=Thu, 31 Dec 2099 23:59:59 UTC;path=/',window[disableStr]=!0}var gaProperty='UA-XXXXXXXX-X',disableStr='ga-disable-'+gaProperty;document.cookie.indexOf(disableStr+'=true')>-1&&(window[disableStr]=!0); ... ga('set', 'anonymizeIp', 1); ``` If your visitors should be able to set an Opt-Out-Cookie (No future tracking) you can set a link e.g. in your imprint as follows: `Deactivate Google Analytics` ### `respectDNT` If you enable this optional option, Google Analytics will not be loaded at all for visitors that have "Do Not Track" enabled. While using Google Analytics does not necessarily constitute Tracking, you might still want to do this to cater to more privacy oriented users. If you are testing this, make sure to disable Do Not Track settings in your own browser. For Chrome, Settings > Privacy and security > More Then disable `Send a "Do Not Track" request with your browsing traffic` ### `exclude` If you need to exclude any path from the tracking system, you can add it (one or more) to this optional array as glob expressions. ### `pageTransitionDelay` If your site uses any custom transitions on route update (e.g. [`gatsby-plugin-transition-link`](https://www.gatsbyjs.com/blog/2018-12-04-per-link-gatsby-page-transitions-with-transitionlink/)), then you can delay processing the page view event until the new page is mounted. ### `optimizeId` If you need to use Google Optimize for A/B testing, you can add this optional Optimize container id to allow Google Optimize to load the correct test parameters for your site. ### `experimentId` If you need to set up SERVER_SIDE Google Optimize experiment, you can add the experiment ID. The experiment ID is shown on the right-hand panel on the experiment details page. [Server-side Experiments](https://developers.google.com/optimize/devguides/experiments) ### `variationId` Besides the experiment ID you also need the variation ID for SERVER_SIDE experiments in Google Optimize. Set 0 for original version. ### `enableWebVitalsTracking` Optimizing for the quality of user experience is key to the long-term success of any site on the web. Capturing Real user metrics (RUM) helps you understand the experience of your user/customer. By setting `enableWebVitalsTracking` to `true`, Google Analytics will get ["core-web-vitals"](https://web.dev/vitals/) events with their values. We send three metrics: - **Largest Contentful Paint (LCP)**: measures loading performance. To provide a good user experience, LCP should occur within 2.5 seconds of when the page first starts loading. - **First Input Delay (FID)**: measures interactivity. To provide a good user experience, pages should have a FID of 100 milliseconds or less. - **Cumulative Layout Shift (CLS)**: measures visual stability. To provide a good user experience, pages should maintain a CLS of 1 or less. ## Optional Fields This plugin supports all optional Create Only Fields documented in [Google Analytics](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#create): - `name`: string, tracker name - `clientId`: string - `sampleRate`: number - `siteSpeedSampleRate`: number - `alwaysSendReferrer`: boolean - `allowAnchor`: boolean - `cookieName`: string - `cookieFlags`: string - `cookieDomain`: string, defaults to `'auto'` if not given - `cookieExpires`: number - `storeGac`: boolean - `legacyCookieDomain`: string - `legacyHistoryImport`: boolean - `allowLinker`: boolean - `storage`: string This plugin also supports several optional General fields documented in [Google Analytics](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#general): - `allowAdFeatures`: boolean - `dataSource`: string - `queueTime`: number - `forceSSL`: boolean - `transport`: string These fields can be specified in the plugin's `options` as shown in the [How to use](#how-to-use) section. ## TrackCustomEvent Function To allow custom events to be tracked, the plugin exposes a function to include in your project. To use it, import the package and call the event within your components and business logic. ```jsx import React from "react" import { trackCustomEvent } from "gatsby-plugin-google-analytics" const Component = () => (
) export default Component ``` ### All Fields Options - `category`: string - required - `action`: string - required - `label`: string - `value`: integer - `nonInteraction`: bool - `transport`: string - `hitCallback`: function For more information see the [Google Analytics](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#events) documentation. #### hitCallback A timeout is included by default incase the Analytics library fails to load. For more information see [Google Analytics - Handling Timeouts](https://developers.google.com/analytics/devguides/collection/analyticsjs/sending-hits#handling_timeouts) ## Troubleshooting ### No actions are tracked #### Check the tracking ID Make sure you supplied the correct Google Analytics tracking ID. It should look like this: `trackingId: "UA-111111111-1"` #### Make sure plugin and script are loaded first The analytics script tag is not properly loaded into the DOM. You can fix this by moving the plugin to the top of your `gatsby-config.js` and into the head of the DOM: ```javascript module.exports = { siteMetadata: { /* your metadata */ }, plugins: [ // Make sure this plugin is first in the array of plugins { resolve: `gatsby-plugin-google-analytics`, options: { trackingId: "UA-111111111-1", // this option places the tracking script into the head of the DOM head: true, // other options }, }, ], // other plugins } ``` --- _Source: https://npm.io/package/gatsby-plugin-google-analytics · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._