Installation

Install the plugin and get your GA4 dashboard running in your Sanity Studio.

npm

Package Managers

npm install sanity-plugin-ga-dashboard

yarn add sanity-plugin-ga-dashboard

pnpm add sanity-plugin-ga-dashboard

Requirements

Peer Dependencies

The plugin requires the following peer dependencies. Most are already included in a standard Sanity + Next.js project:

npm install @sanity/icons @sanity/ui recharts

Register the Plugin

Add the plugin to your sanity.config.ts (or .js) file:

import { defineConfig } from 'sanity'
import { googleAnalyticsPlugin } from 'sanity-plugin-ga-dashboard'

export default defineConfig({
  name: 'your-project',
  title: 'Your Project',
  projectId: 'your-project-id',
  dataset: 'production',
  plugins: [
    googleAnalyticsPlugin(),  // Add the GA4 dashboard
    // ... other plugins
  ],
  schema: {
    types: [
      // ... your schema types
    ],
  },
})

Install in Both Packages

If your project uses a monorepo structure (like the Sanity + Next.js template), you need to install the plugin in both your studio and web packages:

# In your studio package (for the Sanity Studio dashboard)
cd studio
npm install sanity-plugin-ga-dashboard

# In your frontend package (for the API route)
cd frontend
npm install sanity-plugin-ga-dashboard