@dub/analytics
is a client-side script for tracking conversion events with Dub.
By default, the script handles the detection of the dub_id
query parameter and storing it as a first-party cookie:

dub_id
cookie and attribute the conversion to the original click by tracking a lead event.


Quickstart
First, you’ll need to enable conversion tracking for your Dub links to be able to start tracking conversions:If you’re using Dub Partners, you can skip this step
since partner links will have conversion tracking enabled by default.
Option 1: On a workspace-level
Option 1: On a workspace-level
To enable conversion tracking for all future links in a workspace, you can do the following:
To enable conversion tracking for all future links in a workspace, you can do the following:
This option will enable conversion tracking in the Dub Link Builder for all future links.
- Navigate to your workspace’s Analytics settings page.
- Toggle the Workspace-level Conversion Tracking switch to enable conversion tracking for the workspace.

Option 2: On a link-level
Option 2: On a link-level
If you don’t want to enable conversion tracking for all your links in a workspace, you can also opt to enable it on a link-level.To enable conversion tracking for a specific link, open the Dub Link Builder for a link and toggle the Conversion Tracking switch.

You can also use the
C
keyboard shortcut when inside the link builder to
quickly enable conversion tracking for a given link.Option 3: Via the API
Option 3: Via the API
Alternatively, you can also enable conversion tracking programmatically via the Dub API. All you need to do is pass
trackConversion: true
when creating or updating a link:Then, you’ll need to install the Dub client-side script and set up the necessary configuration for client-side conversion tracking:
1
Generate your publishable key
Before you can track conversions on the client-side, you need to generate a publishable key from your Dub workspace.To do that, navigate to your workspace’s Analytics settings page and generate a new publishable key under the Publishable Key section.

2
Allowlist your site's domain
Then, you’ll need to allowlist your site’s domain to allow the client-side conversion events to be ingested by Dub.To do that, navigate to your workspace’s Analytics settings page and add your site’s domain to the Allowed Hostnames list.This provides an additional layer of security by ensuring only authorized domains can track conversions using your publishable key.
You can group your hostnames when adding them to the allow list:

example.com
: Tracks traffic only fromexample.com
.*.example.com
: Tracks traffic from all subdomains ofexample.com
, but not fromexample.com
itself.
When testing things out locally, you can add
localhost
to the Allowed
Hostnames list temporarily. This will allow local events to be ingested by
Dub. Don’t forget to remove it once you’re ready to go live!3
Install @dub/analytics package
Next, install the Dub analytics script in your application.You can install the
@dub/analytics
script in several different ways:You must configure the publishable key you generated in step 1 when installing the analytics script. Without this key, client-side conversion tracking will not work.Client-side lead tracking
Once the analytics script is installed, you can start tracking lead events in your application on the client-side. Here are the quickstart examples for tracking lead events:Property | Required | Description |
---|---|---|
clickId | Yes | The unique ID of the click that the lead conversion event is attributed to. You can read this value from dub_id cookie. If an empty string is provided (i.e. if you’re using tracking a deferred lead event), Dub will try to find an existing customer with the provided customerExternalId and use the clickId from the customer if found. |
eventName | Yes | The name of the lead event to track. Can also be used as a unique identifier to associate a given lead event for a customer for a subsequent sale event (via the leadEventName prop in /track/sale ). |
customerExternalId | Yes | The unique ID of the customer in your system. Will be used to identify and attribute all future events to this customer. |
customerName | No | The name of the customer. If not passed, a random name will be generated (e.g. “Big Red Caribou”). |
customerEmail | No | The email address of the customer. |
customerAvatar | No | The avatar URL of the customer. |
mode | No | The mode to use for tracking the lead event. async will not block the request; wait will block the request until the lead event is fully recorded in Dub; deferred will defer the lead event creation to a subsequent request. |
metadata | No | Additional metadata to be stored with the lead event. Max 10,000 characters. |
- User registration or account creation
- Newsletter subscription
- Contact form submission
- Demo request or trial signup
- Download of gated content
Client-side sale tracking
Once the analytics script is installed, you can start tracking sale events in your application on the client-side.Property | Required | Description |
---|---|---|
customerExternalId | Yes | The unique ID of the customer in your system. Will be used to identify and attribute all future events to this customer. |
amount | Yes | The amount of the sale in cents. |
paymentProcessor | No | The payment processor that processed the sale (e.g. Stripe, Shopify). Defaults to “custom”. |
eventName | No | The name of the event. Defaults to “Purchase”. |
invoiceId | No | The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID. |
currency | No | The currency of the sale. Defaults to “usd”. |
metadata | No | An object containing additional information about the sale. |
- Completing a checkout or order
- Subscription payment
- Invoice payment
- Any paid trial or demo conversion