Configuration

Options are passed in sublim.o with the script tag, or to init() with the npm package. Only projectId is required.

JavaScript

sublim.o = {
  projectId: 'YOUR_PROJECT_ID',
  hashMode: true,
  debug: true,
};

Project

Option	Type	Default	Description
`projectId`	`string`	—	Required. Your project's ID (Settings → Installation). Needed for e-commerce detection, the dataLayer and session replay.
`workspaceId`	`string`	—	Optional. Alone, without `projectId`, it lets Sublim find the project from the site's domain (beta, must be enabled for your workspace).

Pageviews

Option	Type	Default	Description
`autocapture`	`boolean`	`true`	Tracks client-side navigations (`pushState`, `replaceState`, back/forward) as pageviews.
`trackPageview`	`boolean`	`true`	Sends the pageview of the initial page load. With `autocapture` on, that pageview is sent anyway: set both to `false` to send every pageview yourself.
`hashMode`	`boolean`	`false`	For apps routed with the URL hash (`#/page`): the hash becomes the page, and hash changes count as pageviews.

See Pageviews & SPAs.

Automatic tracking

Option	Type	Default	Description
`trackForms`	`boolean`	`true`	Lead form submissions (`form_submit`). See Forms & leads.
`trackDownloads`	`boolean`	`true`	File download clicks (`file_download`). See File downloads.
`trackAddToCart`	`boolean`	`true`	Add-to-cart button clicks (`add_to_cart`).
`addToCartPatterns`	`string[]`	built-in list	Button texts that count as add-to-cart. Replaces the built-in multilingual list. Matching is case-insensitive and partial.
`trackCart`	`boolean`	`true`	Cart total and purchase detection on the cart and thank-you pages set in the dashboard. See E-commerce.
`dataLayer`	`boolean`	project setting	Forward Google dataLayer (GA4 / GTM) events. `true` / `false` override the project's setting. See Google dataLayer.
`dataLayerName`	`string`	`'dataLayer'`	Name of the dataLayer variable, if your tag manager uses another one.

Session replay

Option	Type	Default	Description
`sessionReplay`	`boolean`	`true`	Records sessions when replay is enabled for the project (and within its quota). Also enables the frustration signals.
`replay`	module or `() => import(…)`	—	npm only. Bundles the recorder instead of loading it from the CDN: `replay: () => import('@sublim_analytics/tracker/replay')`.
`sessionReplayBatchSize`	`number`	`250`	Recording events sent per batch.
`sessionReplayBatchInterval`	`number` (ms)	`5000`	Maximum time between two batches.

See Session replay.

Environment

Option	Type	Default	Description
`trackLocalhost`	`boolean`	`false`	Track on `localhost`, `127.0.0.1` and `[::1]`. Use it in development only.
`debug`	`boolean`	`false`	Logs what the tracker does in the browser console.
`endpoint`	`string`	`https://tracker.sublimanalytics.com/api/v2/events`	Ingestion URL. Only change it if Sublim gives you another one.
`cdnUrl`	`string`	`https://cdn.sublimanalytics.com`	Where the session replay scripts are loaded from.

Settings managed in the dashboard

Some behaviour is configured per project in the dashboard rather than in the snippet. The tracker fetches it on its own and caches it in localStorage.

Thank-you page URL and cart page URL, used by purchase and cart detection.
Google dataLayer: on/off, the list of forwarded events, and whether to wait for consent.
Session replay: on/off and quotas.
Exclusions: IPs, paths, hostnames and countries that are ignored.