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/geolocation.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.

Geolocation

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

Latest release version badge for the Snowplow JavaScript Tracker

If this plugin is enabled, the tracker will attempt to create a context from the visitor’s geolocation information. If the visitor has not already given or denied the website permission to use their geolocation information, a prompt will appear. If they give permission, then all events from that moment on will include their geolocation information.

Installation​

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

Initialization​

javascript
import { newTracker, trackPageView } from '@snowplow/browser-tracker';
import { GeolocationPlugin, enableGeolocationContext } from '@snowplow/browser-plugin-geolocation';

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

enableGeolocationContext();

Functions​

enableGeolocationContext

Documentation

Context​

Adding this plugin will automatically capture the following context:

ContextExample
iglu:com.snowplowanalytics.snowplow/geolocation_context/jsonschema/1-1-0Example geolocation context JSON showing latitude, longitude, latitudeLongitudeAccuracy, altitude, altitudeAccuracy, bearing, speed, and timestamp fields

Was this page helpful?