caution

You are reading documentation for an outdated version. Here’s the latest one!

Site search tracking

Site search tracking are provided as part of the Site tracking plugin. This plugin also provides events for social media interactions and timings.

Site search events must be manually tracked.

Install plugin

JavaScript (tag)

Tracker Distribution	Included
sp.js	✅
sp.lite.js	❌

Download:

Download from GitHub Releases (Recommended)	Github Releases (plugins.umd.zip)
Available on jsDelivr	jsDelivr (latest)
Available on unpkg	unpkg (latest)

Note: The links to the CDNs above point to the current latest version. You should pin to a specific version when integrating this plugin on your website if you are using a third party CDN in production.

window.snowplow('addPlugin',
  "https://cdn.jsdelivr.net/npm/@snowplow/browser-plugin-site-tracking@3/dist/index.umd.min.js",
  ["snowplowSiteTracking", "SiteTrackingPlugin"]
);

Browser (npm)

• npm install @snowplow/browser-plugin-site-tracking@3
• yarn add @snowplow/browser-plugin-site-tracking@3
• pnpm add @snowplow/browser-plugin-site-tracking@3

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

newTracker('sp1', '{{collector_url}}', {
   appId: 'my-app-id',
   plugins: [ SiteTrackingPlugin() ],
});

Event

Use the trackSiteSearch method to track users searching your website. Here are its arguments:

Name	Required?	Description	Type
terms	Yes	Search terms	array
filters	No	Search filters	JSON
totalResults	No	Results found	number
pageResults	No	Results displayed on first page	number

An example:

JavaScript (tag)

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

Browser (npm)

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

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

Site search events are implemented as Snowplow self-describing events. Here is the schema for a site_search event.