Setup

Install the analytics library:

pnpm add @crxbase/analytics

Add the alarms permission to your extension manifest:

{
  "permissions": ["alarms"]
}

If your manifest already has a permissions list, add alarms to it. The library has separate extension and website entry points. Both use the same crxbase project ID. Initialize the extension entry point in your background script:

import { analytics } from "@crxbase/analytics/extension";

analytics.init({
  projectId: "YOUR_PROJECT_ID",
  welcomeUrl: "https://example.com/extension/welcome",
  uninstallUrl: "https://example.com/extension/goodbye",
});

The uninstall URL is optional. If you already have an uninstall page, you can use that page. See Uninstall reporting. Initialize the website entry point on your landing and welcome pages:

import { analytics } from "@crxbase/analytics/web";

analytics.init({ projectId: "YOUR_PROJECT_ID" });

On the welcome page, call analytics.attributeInstall() after initialization. The extension integration supports Chrome extensions using Manifest V3.

Get started

Track and identify

Understand your data

Reference