Doku
Die Dokumentation durchsuchen

Tracker script attributes reference

Every data- attribute the pa.js tracker reads from its script tag, with defaults and examples for modules, SPA mode, domains, exclusions and masks.

Als Markdown anzeigen

Attributes are read once, from the <script> tag that loads pa.js. Boolean attributes must be the string "true". Any other value (or no attribute) means off.

Attribute Default Description
data-site required Your site id, e.g. pa_7Q2K9XH3AB. Not a secret
data-modules engage Comma-separated modules: engage, auto, vitals, clicks. Setting it replaces the default, so include engage to keep time on page and scroll depth. data-modules="" loads none. See Modules
data-spa auto auto: follow history.pushState, popstate and hashchange, and keep route-like fragments (#/…, #!/…) in the path. history: follow history.pushState and popstate only. hash: follow hashchange only and keep every #fragment in the path. off: only the initial page load. See SPAs
data-manual false true turns off the automatic pageview on load. SPA navigations are still tracked unless data-spa="off". See Manual mode
data-domains None Comma-separated hostnames to track on, e.g. example.com,www.example.com. On any other hostname nothing is sent. Exact match, so example.com does not cover www.example.com
data-exclude None Comma-separated path globs not to track, e.g. /admin/*,/preview/*. * matches any characters, including /. Matched against the path without the query string. A matching page sends nothing at all
data-mask None Comma-separated pattern->replacement rules, e.g. /users/*/settings->/users/:id/settings. The first matching glob replaces the whole path. * matches any characters, including /
data-params None Extra query parameters to keep in the URL sent, e.g. page,sort. Also add them to Allowed query parameters (Site settings → Privacy) or the server drops them
data-canonical false true reports the URL of <link rel="canonical"> instead of the address bar URL, when the page has one
data-hash false true keeps every #fragment as part of the path and follows hashchange (unless data-spa="off"). Implied by data-spa="hash"
data-api https://privatusstats.com Where hits go and modules load from. Hits go to {data-api}/api/event, modules load from {data-api}/js/pa.<module>.js. Only needed when you host a copy of pa.js yourself. See Versioning and SRI
data-props None Name of a global function that returns an object of properties. It is called for every hit and its result is added to the hit, e.g. data-props="privatusProps". Properties passed to track(), pageview() or props() win over it
data-namespace privatus Name of the global object (window.privatus). Change it if the name is taken or you run two trackers
data-debug false true logs each hit to the console instead of sending it, and allows localhost. See Debug mode
data-allow-local false true sends hits from localhost, 127.*, [::1], 0.0.0.0, .local hosts and file://. See Debug mode

Always kept query parameters#

Whatever data-params says, the tracker keeps these parameters so the server can attribute the visit: utm_*, ref, via, source, and the click ids gclid, gbraid, wbraid, msclkid, fbclid, ttclid, li_fat_id, twclid, dclid. Everything else in the query string is removed in the browser before sending. The server then stores the UTM values and one ref value (the first of ref, via and source that is present), reduces click ids to a yes/no "paid click" flag, and drops the rest (see data minimization).

Examples#

A marketing site with automatic events, no admin pages and pretty paths:

html 
<script defer src="https://privatusstats.com/js/pa.js"
        data-site="pa_YOURSITEID"
        data-modules="engage,auto,vitals,clicks,ask"
        data-exclude="/wp-admin/*,/preview/*"
        data-mask="/orders/*->/orders/:id"></script>

A hash-routed app that adds the plan to every hit:

html 
<script>
  function privatusProps() { return { plan: window.currentPlan || 'free' } }
</script>
<script defer src="https://privatusstats.com/js/pa.js"
        data-site="pa_YOURSITEID"
        data-modules="engage,auto,vitals,clicks,ask"
        data-spa="hash"
        data-props="privatusProps"></script>

Not an attribute: Do Not Track and GPC#

The tracker always reports whether the browser sends Do Not Track or Global Privacy Control. Whether those hits are dropped is a site setting (Site settings → Privacy): GPC is honored by default, DNT is not. See DNT and GPC.