JavaScript SDK reference

The Dozenfold SDK is one script, https://cdn.dozenfold.com/sdk/v1.js, that defines window.Dozenfold. On Shopify the theme app embed loads and starts it for you; you only call the methods below for handled errors or extra milestones. On a custom site you call init yourself; see Install on a custom site.

Every method is safe to call at any time. None throws, and calls made before collection starts or without consent return false and send nothing.

What it captures on its own

After init, without further code:

• uncaught errors, unhandled promise rejections, errors thrown in timers and event listeners, and Error objects passed to console.error, with cause chains and AggregateError members
• failed requests (fetch and XHR, including cart and GraphQL failures) and failed scripts, styles and images, plus CSP violations
• page views with their page type, and the session’s landing page, channel and campaign
• LCP, INP and CLS per page view, and browser stalls (long tasks) where supported
• rage clicks, dead-click candidates, repeated submits and similar friction patterns
• on Shopify, funnel stages through the Web Pixel

It does not capture input values, request or response bodies, or a persistent shopper identity.

init(options)

await Dozenfold.init({
  siteId: 'site_…',
  token: 'omz_pub_v1_…',
  origin: window.location.origin,
  consent: 'granted',
  release: 'web@2026.10.06',
  currency: 'EUR',
  pageTypes: { pdp: ['/p', '/design'], plp: ['/c'] },
});

init throws only for invalid site options (missing id, both ids, or an origin that does not match the page) and an invalid release. Everything else fails quietly.

Consent

Change it later with setConsent.

Page types

Page types drive the journey funnel, page groups and revenue impact strata. Shopify paths (/products, /collections, /cart, /search, /checkout) are recognised without configuration. A custom site maps its own prefixes:

pageTypes: { pdp: ['/design'], plp: ['/shop', '/c'], checkout: ['/pay'] }

Prefixes match whole path segments: /design matches /design/123, not /designer. The longest prefix wins, and up to 100 prefixes are used.

Methods

true means queued, not delivered.

funnel

Dozenfold.funnel('product_viewed', { product_id: 'sku-123' });
Dozenfold.funnel('product_added_to_cart', { product_id: 'sku-123' });
Dozenfold.funnel('checkout_started');
Dozenfold.funnel('checkout_completed', { order_value: 129.9, currency_code: 'EUR' });

Stages: page_viewed, product_viewed, product_added_to_cart, checkout_started, checkout_contact_info_submitted, checkout_address_info_submitted, checkout_shipping_info_submitted, payment_info_submitted, checkout_completed. Properties are limited to product_id (string, up to 255 characters), order_value (non-negative number) and currency_code (three uppercase letters). Send order_value on checkout_completed to get revenue amounts; without it, impact reads in orders per day.

track

Dozenfold.track('wishlist_added', { quantity: 1, amount: 49.95, currency_code: 'USD' });

Names: wishlist_added, wishlist_removed, product_compared, promotion_viewed, promotion_clicked, search_submitted. Properties: bounded quantity, paired amount + currency_code, and boolean success. Up to 50 milestones per session. Free-text labels are rejected.

Error-session replay

Replay is not an SDK option. Turn it on in Settings → Session replay. The SDK then loads replay-v1.js from the same CDN folder in sampled sessions with granted consent. See Error-session replay.

What the SDK never does to the store

The SDK is built so that a failure on our side never becomes a failure on yours:

• Its own requests use the browser’s native fetch, not the page’s. They do not pass through fetch wrappers installed by the theme or its apps, and those apps never see our traffic.
• Keepalive budget. Browsers share 64 KB of keepalive requests per page. Dozenfold uses at most 32 KB and 8 requests of it, shared with replay, so the store’s own analytics and ad conversion beacons on page exit keep their room.
• Wrappers are pass-through. Request and listener wrappers return the original result and re-throw the original error; window.open always opens the popup, even if our bookkeeping fails.
• No events dispatched to the page. setConsent never fires Shopify’s consent DOM event, so other scripts listening to it are not re-triggered.
• Replay backs off. A DOM mutation flood or a collector rate limit stops recording instead of slowing the page.
• Bots are skipped. In search-engine renderers, headless browsers and synthetic monitors (navigator.webdriver, Googlebot, Bingbot, Lighthouse and similar), init installs nothing.
• Our frames stay out of your issues. Stack frames from cdn.dozenfold.com/sdk are ignored when grouping errors.