@amplitude/plugin-web-attribution-browser NPM

@amplitude/plugin-web-attribution-browser

Official Browser SDK plugin for web attribution tracking

Installation

This package is published on NPM registry and is available to be installed using npm and yarn.

# npm
npm install @amplitude/plugin-web-attribution-browser

# yarn
yarn add @amplitude/plugin-web-attribution-browser

Usage

This plugin works on top of Amplitude Browser SDK and adds web attribution tracking features to built-in features. To use this plugin, you need to install @amplitude/analytics-browser version v2.0.0 or later.

1. Import Amplitude packages

@amplitude/plugin-web-attribution-browser

import { webAttributionPlugin } from '@amplitude/plugin-web-attribution-browser';

2. Instantiate page view plugin

The plugin accepts an optional parameter of type Object to configure the plugin based on your use case.

const webAttributionTracking = webAttributionPlugin(amplitude, {
  excludeReferrers: undefined,
  initialEmptyValue: undefined,
  resetSessionOnNewCampaign: undefined,
});

Options

Name	Type	Default	Description
`excludeReferrers`	`(string \\| RegExp)[]`	`[]`	Use this option to prevent the plugin from tracking campaigns parameters from specific referrers. For example: `subdomain.domain.com`.
`initialEmptyValue`	`string`	`"EMPTY"`	Use this option to specify empty values for first-touch attribution.
`resetSessionOnNewCampaign`	`boolean`	`false`	Use this option to control whether a new session should start on a new campaign.

3. Install plugin to Amplitude SDK

amplitude.add(webAttributionTracking);

4. Initialize Amplitude SDK

amplitude.init('API_KEY');

Resulting web attribution event

This plugin tracks campaign parameters based on your configuration. A web attribution event is composed of the following values:

Event type

"$idenfity"

User properties

Property	Description
`utm_source`	URL query parameter value for `utm_source`
`utm_medium`	URL query parameter value for `utm_medium`
`utm_campaign`	URL query parameter value for `utm_campaign`
`utm_term`	URL query parameter value for `utm_term`
`utm_content`	URL query parameter value for `utm_content`
`referrer`	Referring webstite or `document.referrer`
`referring_domain`	Referring website's domain, including subdomain
`dclid`	URL query parameter value for `dclid`
`gbraid`	URL query parameter value for `gbraid`
`gclid`	URL query parameter value for `gclid`
`fbclid`	URL query parameter value for `fbclid`
`ko_click_id`	URL query parameter value for `ko_click_id`
`li_fat_id`	URL query parameter value for `li_fat_id`
`msclkid`	URL query parameter value for `msclkid`
`rtd_cid`	URL query parameter value for `rtd_cid`
`ttclid`	URL query parameter value for `ttclid`
`twclid`	URL query parameter value for `twclid`
`wbraid`	URL query parameter value for `wbraid`