@snowplow/browser-plugin-site-tracking
TypeScript icon, indicating that this package has built-in type declarations

4.0.1 • Public • Published

Snowplow Site Tracking

npm version License

Browser Plugin to be used with @snowplow/browser-tracker.

Adds site tracking based events to your Snowplow tracking.

Maintainer quick start

Part of the Snowplow JavaScript Tracker monorepo.
Build with Node.js (18 - 20) and Rush.

Setup repository

npm install -g @microsoft/rush 
git clone https://github.com/snowplow/snowplow-javascript-tracker.git
rush update

Package Installation

With npm:

npm install @snowplow/browser-plugin-site-tracking

Usage

Initialize your tracker with the SiteTrackingPlugin:

import { newTracker } from '@snowplow/browser-tracker';
import { SiteTrackingPlugin } from '@snowplow/browser-plugin-site-tracking';

newTracker('sp1', '{{collector}}', { plugins: [ SiteTrackingPlugin() ] }); // Also stores reference at module level

Then use the trackX functions from this package to track to all trackers which have been initialized with this plugin:

import { trackSocialInteraction, trackSiteSearch, trackTiming } from '@snowplow/browser-plugin-site-tracking';

trackSocialInteraction({
  action: 'retweet',
  network: 'twitter',
  target: '1234',
});

trackSiteSearch({
  terms: ['unified', 'log'],
  filters: { category: 'books', 'sub-category': 'non-fiction' },
  totalResults: 14,
  pageResults: 8,
});

trackTiming({
  category: 'load',
  variable: 'map_loaded',
  timing: 50,
  label: 'Map loading time',
});

Copyright and license

Licensed and distributed under the BSD 3-Clause License (An OSI Approved License).

Copyright (c) 2022 Snowplow Analytics Ltd, 2010 Anthon Pang.

All rights reserved.

Readme

Keywords

none

Package Sidebar

Install

npm i @snowplow/browser-plugin-site-tracking

Homepage

bit.ly/sp-js

Weekly Downloads

7,508

Version

4.0.1

License

BSD-3-Clause

Unpacked Size

600 kB

Total Files

12

Last publish

Collaborators

  • snowplow-analytics
  • cogsp
  • paul_boocock