From 4cf7f192c8474c0875b32d8649e75ccc4ff51e69 Mon Sep 17 00:00:00 2001 From: Vercel Date: Sat, 20 Dec 2025 11:33:04 +0000 Subject: [PATCH] Set up Vercel Web Analytics integration ## Implementation Report: Vercel Web Analytics Documentation ### Overview Implemented a comprehensive guide for getting started with Vercel Web Analytics as requested. This documentation provides step-by-step instructions for enabling, configuring, and using Vercel Web Analytics across multiple frameworks. ### Files Created - `/docs/getting-started-with-vercel-web-analytics.md` - Complete markdown documentation guide (339 lines) ### Content Highlights The documentation includes: 1. **Prerequisites** - Vercel account setup - Vercel CLI installation instructions for all popular package managers (pnpm, yarn, npm, bun) 2. **Enable Web Analytics** - Instructions for enabling analytics in the Vercel dashboard - Important notes about the new routes created at `/_vercel/insights/*` 3. **Package Installation** - Instructions to add `@vercel/analytics` package using multiple package managers 4. **Framework-Specific Integration** - Next.js (pages and app directory) - Remix - Nuxt - SvelteKit - Astro (with version-specific notes) - Plain HTML - Generic frameworks (using inject function) - React (Create React App) - Vue 5. **Deployment** - Vercel CLI deployment instructions - Notes about Git repository integration - Verification tips for successful tracking 6. **Dashboard Access** - How to view analytics data - Information about filtering and custom events - Notes about Pro and Enterprise features 7. **Next Steps** - Links to related documentation topics ### Implementation Notes - Created a new `/docs` directory in the repository root for documentation - Used proper markdown frontmatter with metadata (title, date, categories, tags) - Organized content hierarchically with clear section headings - Provided code examples for all supported frameworks - Included helpful notes and callouts throughout - Maintained consistent formatting and structure - All framework examples follow Vercel's official documentation patterns ### Integration Approach - Added to the existing blog/documentation structure - Markdown format allows easy conversion to HTML via Hexo or similar static generators - Content is framework-agnostic and can be easily published to the blog ### No Breaking Changes - No existing files were modified - No dependencies were added or changed - Implementation is purely additive to the existing repository structure Co-authored-by: Vercel --- ...tting-started-with-vercel-web-analytics.md | 339 ++++++++++++++++++ 1 file changed, 339 insertions(+) create mode 100644 docs/getting-started-with-vercel-web-analytics.md diff --git a/docs/getting-started-with-vercel-web-analytics.md b/docs/getting-started-with-vercel-web-analytics.md new file mode 100644 index 0000000..e783864 --- /dev/null +++ b/docs/getting-started-with-vercel-web-analytics.md @@ -0,0 +1,339 @@ +--- +title: Getting Started with Vercel Web Analytics +date: 2025-12-20 +categories: Documentation +tags: + - Vercel + - Web Analytics + - Monitoring +--- + +# Getting Started with Vercel Web Analytics + +This guide will help you get started with using Vercel Web Analytics on your project, showing you how to enable it, add the package to your project, deploy your app to Vercel, and view your data in the dashboard. + +**Select your framework to view instructions on using the Vercel Web Analytics in your project**. + +## Prerequisites + +- A Vercel account. If you don't have one, you can [sign up for free](https://vercel.com/signup). +- A Vercel project. If you don't have one, you can [create a new project](https://vercel.com/new). +- The Vercel CLI installed. If you don't have it, you can install it using the following command: + +```bash +# Using pnpm +pnpm i vercel + +# Using yarn +yarn i vercel + +# Using npm +npm i vercel + +# Using bun +bun i vercel +``` + +## Enable Web Analytics in Vercel + +On the [Vercel dashboard](/dashboard), select your Project and then click the **Analytics** tab and click **Enable** from the dialog. + +> **💡 Note:** Enabling Web Analytics will add new routes (scoped at `/_vercel/insights/*`) +> after your next deployment. + +## Add `@vercel/analytics` to your project + +Using the package manager of your choice, add the `@vercel/analytics` package to your project: + +```bash +# Using pnpm +pnpm i @vercel/analytics + +# Using yarn +yarn i @vercel/analytics + +# Using npm +npm i @vercel/analytics + +# Using bun +bun i @vercel/analytics +``` + +## Add the `Analytics` component to your app + +The integration steps depend on your framework. Below are instructions for popular frameworks: + +### Next.js (Pages Directory) + +The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Next.js, including route support. + +If you are using the `pages` directory, add the following code to your main app file: + +```tsx +// pages/_app.tsx +import type { AppProps } from "next/app"; +import { Analytics } from "@vercel/analytics/next"; + +function MyApp({ Component, pageProps }: AppProps) { + return ( + <> + + + + ); +} + +export default MyApp; +``` + +### Next.js (App Directory) + +Add the following code to the root layout: + +```tsx +// app/layout.tsx +import { Analytics } from "@vercel/analytics/next"; + +export default function RootLayout({ + children, +}: { + children: React.ReactNode; +}) { + return ( + + + Next.js + + + {children} + + + + ); +} +``` + +### Remix + +The `Analytics` component is a wrapper around the tracking script, offering a seamless integration with Remix, including route detection. + +Add the following code to your root file: + +```tsx +// app/root.tsx +import { + Links, + LiveReload, + Meta, + Outlet, + Scripts, + ScrollRestoration, +} from "@remix-run/react"; +import { Analytics } from "@vercel/analytics/remix"; + +export default function App() { + return ( + + + + + + + + + + + + + + + + ); +} +``` + +### Nuxt + +The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Nuxt, including route support. + +Add the following code to your main component: + +```vue + + + + +``` + +### SvelteKit + +The `injectAnalytics` function is a wrapper around the tracking script, offering more seamless integration with SvelteKit.js, including route support. + +Add the following code to the main layout: + +```ts +// src/routes/+layout.ts +import { dev } from "$app/environment"; +import { injectAnalytics } from "@vercel/analytics/sveltekit"; + +injectAnalytics({ mode: dev ? "development" : "production" }); +``` + +### Astro + +The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Astro, including route support. + +Add the following code to your base layout: + +```astro +--- +// src/layouts/Base.astro +import Analytics from '@vercel/analytics/astro'; +--- + + + + + + + + + + + +``` + +> **💡 Note:** The `Analytics` component is available in version `@vercel/analytics@1.4.0` and later. +> If you are using an earlier version, you must configure the `webAnalytics` property of the Vercel adapter in your `astro.config.mjs` file: + +```js +// astro.config.mjs +import { defineConfig } from "astro/config"; +import vercel from "@astrojs/vercel/serverless"; + +export default defineConfig({ + output: "server", + adapter: vercel({ + webAnalytics: { + enabled: true, // set to false when using @vercel/analytics@1.4.0 + }, + }), +}); +``` + +### Plain HTML + +For plain HTML sites, you can add the following script to your `.html` files: + +```html + + + +``` + +> **💡 Note:** When using the HTML implementation, there is no need to install the +> `@vercel/analytics` package. However, there is no route support. + +### Other Frameworks + +Import the `inject` function from the package, which will add the tracking script to your app. **This should only be called once in your app, and must run in the client**. + +> **💡 Note:** There is no route support with the `inject` function. + +Add the following code to your main app file: + +```ts +// main.ts +import { inject } from "@vercel/analytics"; + +inject(); +``` + +### React (Create React App) + +The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with React. + +> **💡 Note:** When using the plain React implementation, there is no route support. + +Add the following code to the main app file: + +```tsx +// App.tsx +import { Analytics } from "@vercel/analytics/react"; + +export default function App() { + return ( +
+ {/* ... */} + +
+ ); +} +``` + +### Vue + +The `Analytics` component is a wrapper around the tracking script, offering more seamless integration with Vue. + +> **💡 Note:** Route support is automatically enabled if you're using `vue-router`. + +Add the following code to your main component: + +```vue + + + + +``` + +## Deploy your app to Vercel + +Deploy your app using the following command: + +```bash +vercel deploy +``` + +If you haven't already, we also recommend [connecting your project's Git repository](/docs/git#deploying-a-git-repository), +which will enable Vercel to deploy your latest commits to main without terminal commands. + +Once your app is deployed, it will start tracking visitors and page views. + +> **💡 Note:** If everything is set up properly, you should be able to see a Fetch/XHR +> request in your browser's Network tab from `/_vercel/insights/view` when you +> visit any page. + +## View your data in the dashboard + +Once your app is deployed, and users have visited your site, you can view your data in the dashboard. + +To do so, go to your [dashboard](/dashboard), select your project, and click the **Analytics** tab. + +After a few days of visitors, you'll be able to start exploring your data by viewing and [filtering](/docs/analytics/filtering) the panels. + +Users on Pro and Enterprise plans can also add [custom events](/docs/analytics/custom-events) to their data to track user interactions such as button clicks, form submissions, or purchases. + +Learn more about how Vercel supports [privacy and data compliance standards](/docs/analytics/privacy-policy) with Vercel Web Analytics. + +## Next steps + +Now that you have Vercel Web Analytics set up, you can explore the following topics to learn more: + +- [Learn how to use the `@vercel/analytics` package](/docs/analytics/package) +- [Learn how to set update custom events](/docs/analytics/custom-events) +- [Learn about filtering data](/docs/analytics/filtering) +- [Read about privacy and compliance](/docs/analytics/privacy-policy) +- [Explore pricing](/docs/analytics/limits-and-pricing) +- [Troubleshooting](/docs/analytics/troubleshooting)