# @amplitude/plugin-web-attribution-browser Latest version **2.2.29** (published 2026-09-29) · MIT license · 0 weekly downloads ## Install ```sh npm install @amplitude/plugin-web-attribution-browser pnpm add @amplitude/plugin-web-attribution-browser yarn add @amplitude/plugin-web-attribution-browser bun add @amplitude/plugin-web-attribution-browser ``` ## Health **Score 75/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 2.2.29 | | Published | 2026-09-29 | | First published | 2022-09-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 3 | | Unpacked size | 83.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 181 | | Author | Amplitude Inc | | Maintainers | curtisbliu, kelson.warner, sdk.dev, eric_amplitude, daniel-graham-amplitude, jjwang123 | ## Links - npm: https://www.npmjs.com/package/@amplitude/plugin-web-attribution-browser - Repository: https://github.com/amplitude/Amplitude-TypeScript - Issues: https://github.com/amplitude/Amplitude-TypeScript/issues - npm.io page: https://npm.io/package/@amplitude/plugin-web-attribution-browser ## Dependencies (3) - [tslib](https://npm.io/package/tslib.md) ^2.4.1 - [@amplitude/analytics-core](https://npm.io/package/@amplitude/analytics-core.md) 2.59.0 - [@amplitude/analytics-types](https://npm.io/package/@amplitude/analytics-types.md) 2.11.1 ## Recent versions - 2.2.29 (latest) — 2026-09-29 - 2.2.27-video-analytics-5.0 (video-analytics-5) — 2026-09-22 - 2.2.26-video-analytics-4.0 (video-analytics-4) — 2026-09-17 - 2.2.25-video-analytics-2.0 (video-analytics-2) — 2026-09-09 - 2.2.23-video-analytics.0 (video-analytics) — 2026-07-31 - 2.2.14-featelement-selector-v1.0 (featelement-selector-v1) — 2026-06-15 - 2.2.13-SR-4497-custom-transport-hooks.0 (SR-4497-custom-transport-hooks) — 2026-06-09 - 2.2.12-sr-perf-reliability-rc.0 (sr-perf-reliability-rc) — 2026-06-05 - 2.2.12-sr-4646-rc.0 (sr-4646-rc) — 2026-06-03 - 2.2.11-sr-idb-multitab-test-rc.0 (sr-idb-multitab-test-rc) — 2026-05-04 - 2.2.8-sr-3531-rc-2.0 (sr-3531-rc-2) — 2026-04-20 - 2.2.6-SR-3115-rc2.0 (SR-3115-rc2) — 2026-04-08 - 2.2.6-SR-3115-rc1.0 (SR-3115-rc1) — 2026-04-03 - 2.2.6-SR-3115.0 (SR-3115) — 2026-04-03 - 2.1.119-SR-2728.0 (SR-2728) — 2026-03-12 - … 273 more at https://npm.io/package/@amplitude/plugin-web-attribution-browser/versions ## README


# @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. ```sh # 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` ```typescript 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. ```typescript 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](https://www.docs.developers.amplitude.com/data/sdks/marketing-analytics-browser/#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 ```typescript amplitude.add(webAttributionTracking); ``` ### 4. Initialize Amplitude SDK ```typescript 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`| |`rdt_cid`|URL query parameter value for `rdt_cid`| |`ttclid`|URL query parameter value for `ttclid`| |`twclid`|URL query parameter value for `twclid`| |`wbraid`|URL query parameter value for `wbraid`| --- _Source: https://npm.io/package/@amplitude/plugin-web-attribution-browser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._