import { Analytics as DubAnalytics } from '@dub/analytics/react';

export default function RootLayout({
  children,
}: Readonly<{
  children: React.ReactNode;
}>) {
  return (
    <html lang="en">
      <body>{children}</body>
      <DubAnalytics />
    </html>
  );
}

You can all use the inject() function to add the tracking script to other frameworks.

Available Props

You can pass the following props to the Analytics component to customize the tracking script.

`apiHost`

The API host to use for tracking. The default is https://api.dub.co.

`apiKey`

The publishable API key to use for tracking. Get your publishable API key from your Dub workspace's token settings page.

`attributionModel`

Decide the attribution model to use for tracking. The default is last-click.

first-click - The first click model gives all the credit to the first touchpoint in the customer journey.
last-click - The last click model gives all the credit to the last touchpoint in the customer journey.

`cookieOptions`

The cookieOptions prop accepts the following keys:

Key	Default	Description	Example
`domain`	`null`	Specifies the value for the `Domain` Set-Cookie attribute.	`example.com`
`expires`	90 days from now	Specifies the `Date` object to be the value for the `Expires` Set-Cookie attribute.	`new Date('2024-12-31')`
`expiresInDays`	`90`	Specifies the number (in days) to be the value for the `Expires` Set-Cookie attribute.	`90`
`path`	`/`	Specifies the value for the `Path` Set-Cookie attribute. By default, the path is considered the "default path".	`/`

For example, to set a cross domain cookie, you can use the following code:

import { Analytics as DubAnalytics } from "@dub/analytics"

<DubAnalytics
   cookieOptions={{
      domain: process.env.IS_PRODUCTION_ENV
        ? ".yourdomain.com" // for cross-domain tracking
        : undefined,
   }}
/>

`queryParam`

The query parameter to listen to for client-side click-tracking (e.g. ?ref=abc123). The default is ref.

`scriptProps`

Custom properties to pass to the script tag. Refer to MDN for all available options.

Keywords

FAQs

What is @dub/analytics?

Is @dub/analytics popular?

Is @dub/analytics well maintained?

Package last updated on 01 Oct 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@dub/analytics

Overview

Quick start

Available Props

apiHost

apiKey

attributionModel

cookieOptions

queryParam

scriptProps