Skip to main content

For AI agents: a Markdown version of this page is at https://docs.snowplow.io/docs/sources/web-trackers/previous-versions/browser-tracker-v3-reference/plugins/client-hints.md. The index of all documentation pages is at https://docs.snowplow.io/llms.txt, and the index for this section is at https://docs.snowplow.io/docs/api-reference/llms.txt.

Client Hints

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

Latest release version badge for the Snowplow JavaScript Tracker

Client Hints are being rolled out across a number of browsers and are an alternative the tracking the User Agent, which is particularly useful in those browsers which are freezing the User Agent string.

Installation​

  • npm install @snowplow/browser-plugin-client-hints
  • yarn add @snowplow/browser-plugin-client-hints
  • pnpm add @snowplow/browser-plugin-client-hints

Initialization​

javascript
import { newTracker, trackPageView } from '@snowplow/browser-tracker';
import { ClientHintsPlugin } from '@snowplow/browser-plugin-client-hints';

newTracker('sp1', '{{collector_url}}', {
appId: 'my-app-id',
plugins: [ ClientHintsPlugin() ],
// Use ClientHintsPlugin(true) to capture high entropy values
});

Functions​

This plugin does not contain any new functions.

Context​

Adding this plugin will automatically capture the following context:

ContextExample
iglu:org.ietf/http_client_hints/jsonschema/1-0-0Example client hints context JSON showing isMobile set to false and a brands array containing Google Chrome and Chromium at version 89

Was this page helpful?