Analytics
Pirsch
Configure Pirsch
Copy the identification code from your Pirsch installation snippet. The helper
passes it to the script as data-code.
Register the scripts
Complete your framework quickstart first. Keep its Inth endpoint, policy, styles and consent UI. Remove the vendor's original script, SDK initializer or tag-manager entry, so the vendor loads only through c15t.
The vendor pages put the helper in src/consent-scripts.ts. If your framework
quickstart already has a scripts array, such as the one in c15t.config.ts
in the Next.js guide, add the helper to that array instead of creating a
second file.
The scripts export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration
point for your framework below. These are edits to that provider, not a second
provider.
Add the configuration to scripts in c15t.config.ts, next to
next.config.ts:
Keep the rest of your config, such as mode and routePrefix, in the
same call. ConsentRoot reads the config in the browser, so the layout
keeps passing only state. App Router, Pages Router and static export all
read the same file. See
Next.js scripts and embeds.
Options
| Option | Default | Behavior |
|---|---|---|
identificationCode | Required | Set as data-code. Empty or whitespace-only values log an error and the script does not load. |
domain | None | Extra dashboard domains, each optionally as domain:CODE. An array becomes a comma-separated data-domain. |
dev | None | Hostname Pirsch reports instead of localhost, set as data-dev. Use it to test locally. |
hitEndpoint | None | Page view endpoint, set as data-hit-endpoint. |
eventEndpoint | None | Event endpoint, set as data-event-endpoint. |
disablePageViews | None | true adds data-disable-page-views and stops automatic page views. |
extended | None | true loads https://api.pirsch.io/pirsch-extended.js instead of pa.js. |
scriptUrl | https://api.pirsch.io/pa.js | Loader URL override. Blank values fall back to the default. |
Pirsch finds its script element by ID, so the helper sets the element ID to
pianjs, or to pirschextendedjs with extended.
Loading and revocation
pirsch uses the measurement category. The script loads only while
measurement is allowed. Pirsch starts its custom event bindings from a
DOMContentLoaded listener, which has usually fired by the time a visitor
allows measurement. When the script loads on an already parsed page, the
helper calls window.pirschInit() so those bindings still start.
On revocation the helper removes the script element and calls no Pirsch API.
Verify Pirsch
After you allow measurement, the pa.js request appears and the #pianjs
script element carries your data-code. Allow measurement after the page has
finished loading, then trigger a custom event and check that its request
appears. If your code calls window.pirsch directly, check measurement
permission before each call.
Test in a private window with an opt-in policy. Open DevTools Network, disable the cache and filter by the vendor's domain:
- Load the page. No request goes to the vendor before you choose.
- Click Reject, then reload. There is still no vendor request.
- Open Privacy settings and allow the helper's category. The vendor script loads without a page reload.
- Turn the category off again and save. c15t reloads the page, and the new page makes no vendor request.
c15t reloads on revocation because removing a script element does not stop
code that already ran. The vendor's listeners, timers and queued events stay
alive until the page unloads. If you set reloadOnConsentRevoked: false, stop
the vendor yourself. Register a callback-only script whose onConsentChange
calls the vendor's opt-out API, as shown in
custom integrations, and check the
permission before each of your own event calls. The reload does not delete
cookies the vendor already set; see
clear on revocation for your framework.
The helper sets vendor to its script ID, so once you declare that vendor a
visitor can turn it off inside an allowed category. See
vendor consent for your framework. The
consent verification guide covers navigation,
expiry and hosting checks.