Script attributes and client options

This page lists every setting you can put on the Noxtica script tag and every option you can pass to createClient() or init(), with the accepted values, the default and what each one changes. Use it when you edit the generated tag, wire the collector from your own code, or review a tag someone else pasted.

What it is

Availability: Evaluation access. Availability depends on your plan, role and the modules enabled for your organisation.

The browser collector has two entry points:

• The script tag. The core script reads data-* attributes from its own tag when the page has loaded. Backoffice → Integrations & API → Script & Consent → Snippets generates the tag with your Site Key. Install and consent concepts stay on Install and Browser Runtime.
• Client options. window.NoxticaCollector.createClient(options) takes the same ideas as an object, plus callbacks that an attribute cannot carry (onChallenge, onBlock). The typed @noxtica/sdk wrapper has an init(config) function that forwards a subset of these options. That wrapper is not installable from the public registry today; see SDK family and availability.

The loader reads the attributes once, when the tag initialises. Changing an attribute afterwards has no effect until the next page load. A value the loader cannot parse is ignored and never breaks collection.

Prerequisites

• A domain with a Site Key. Backoffice → Domains lists the key; see Domains, site keys and the install card.
• A page served from the origin registered for that Site Key. A token request from another origin is refused with 403 and {"error":"Origin mismatch"}.
• Workspace admin access to Backoffice → Integrations & API → Script & Consent, if you want to copy the generated tag instead of typing it.
• The core script URL on your collector host: https://collect.noxtica.com/collector/noxtica-collector-core.js. The extensions script takes no attributes and no Site Key; it attaches to the core on the page.

Steps

1. Start from the generated tag

Open Backoffice → Integrations & API → Script & Consent, pick the domain, and copy the core snippet from the Snippets tab. Two switches on that tab add attributes for you: Add data-extensions=“auto” to the core snippet and Add data-consent-mode=“api” to the core snippet.

<script
	src="https://collect.noxtica.com/collector/noxtica-collector-core.js"
	data-site-key="pk_prod_your_site_key_here"
	data-auto-init
	data-auto-check-once
	async
></script>

Keep the file name. The loader binds a tag when its src contains noxtica-collector or /noxtica.js and the tag carries data-auto-init; a tag that misses either condition is ignored. This matters when you copy the script to your own path or serve it through a first-party relay.

2. Set the attributes you need

Two attributes go on your own forms, not on the script tag:

3. Choose how often the page check runs

checkOnce() returns the cached result while the cache window is open and records a visit instead of collecting again. The loader picks the window in this order, and the earliest match wins:

1. ttlSeconds in the call. For the automatic check this is data-ttl-seconds.
2. checkIntervalDays in the call.
3. The client option checkIntervalDays, which data-check-interval-days sets.
4. The checkIntervalDays value in the domain policy delivered with the session token.
5. Seven days.

Call options for checkOnce(options):

4. Create a client from code

Use createClient when a tag with data-auto-init does not fit, for example when your page decides at run time whether to start Noxtica. A client you create yourself does not set window.noxticaClient, does not dispatch noxtica:ready and does not read the command queue. Its results come back through the promises it returns.

<script>
	const tag = document.createElement('script');
	tag.src = 'https://collect.noxtica.com/collector/noxtica-collector-core.js';
	tag.async = true;
	tag.onload = () => {
		const client = window.NoxticaCollector.createClient({
			siteKey: 'pk_prod_your_site_key_here',
			consentMode: 'api',
			logLevel: 'silent',
		});
		client.checkOnce().then((result) => console.log(result.success));
	};
	document.head.appendChild(tag);
</script>

createClient throws NoxticaCollector: siteKey is required when it finds no Site Key, either in the siteKey option or on a collector tag with data-site-key.

The wrapper’s init(config) accepts siteKey, apiUrl, ingestUrl, mode, checkIntervalDays, signatureMode, accountId, debug, logLevel, onChallenge, onBlock, release, buildId, subjectHandle and observability, plus options that are specific to the wrapper:

init() does not pass consentMode to the loader. To declare a mode, put data-consent-mode on the tag or call createClient directly.

5. Set the log level

The loader writes nothing to the console by default. Four sources can change that. The highest one that holds a valid value wins:

1. The data-log-level attribute on the script tag.
2. The logLevel option of createClient() or init(), or NoxticaCollector.setLogLevel(level).
3. The domain setting. In Backoffice open Domains, open the domain, then Configuration → Client log level → Console log level. The choices are SDK default, Silent, Error, Warn, Info and Debug. The value arrives with each session token, so a change applies from the next token.
4. The SDK default: silent, unless data-debug, the debug option or window.NOXTICA_DEBUG = true turns on debug.

silent means no console output from any Noxtica code path. Read the effective level with window.NoxticaCollector.getLogLevel().

A data-log-level attribute applies before the loader reads the other attributes, so it also reveals the warnings from step 2, such as a rejected data-api-url. The domain setting arrives later, with the token.

Verify it works

Run these in the browser console on a page that carries the tag:

typeof window.noxticaClient;            // 'object' when data-auto-init bound the tag
window.noxticaClient.siteKey;           // your Site Key
window.noxticaClient.apiUrl;            // the collector origin in use
window.noxticaClient.ingestUrl;         // the telemetry origin in use
window.NoxticaCollector.VERSION;        // the loader version, for example '3.8.1'
window.noxtica.v;                       // the same version, published for the duplicate-tag guard
window.NoxticaCollector.getLogLevel();  // the effective log level

In DevTools → Network you see POST /client/token on the collector host with status 200. After consent, when the extensions run, and with data-ingest-url left at auto on the default collector, telemetry requests go to ingest.noxtica.com.

Troubleshooting

Related

• Install and Browser Runtime: install, pinned tags, CSP and the check list.
• Client API, events and the command queue: the methods and events these attributes feed.
• Consent modes, GPC and Google Consent Mode: what data-consent-mode and data-extensions do at run time.
• Browser SDK troubleshooting: a symptom table across the whole SDK.
• SDK Changelog: which release added or changed each setting.