Skip to content

Turn collection on or off, set the site's domains or its tracking mode

PATCH
/v1/analytics/settings

Body: { "enabled"?: boolean, "domains"?: string[], "mode"?: "auto" | "consent" | "cookies" | "cookieless", "signup_goal"?: string | null, "signin_goal"?: string | null, "excluded_countries"?: string[] }. Domains are bare hostnames (example.com); a URL is reduced to its host, www. is dropped, at most 10. mode decides when a visit may carry a visitor and session id: auto (new sites) outside the EEA, UK and Switzerland, and inside them only after consent; consent only after consent everywhere; cookies always (your own consent tool decides when the script loads); cookieless never. Global Privacy Control counts as no in every mode. signup_goal and signin_goal name the goal that counts as this site’s signup and sign-in; null uses the recognised names (signup, sign-up, sign_up, register, signup-complete; signin, sign-in, login, log-in, sign_in), which is what data-nordva-signup and data-nordva-signin send. excluded_countries (two-letter codes, at most 20, [] for none) are left out of every analytics read by default, usually your own country so your testing is not counted; nothing is deleted, so clearing the list brings those visits back. To stop counting one browser instead, open your site once in it with ?nordva_ignore=1 (?nordva_ignore=0 undoes it). Takes effect within a minute.

Auth: Secret key only.

object
enabled
boolean
domains
Array<string>
<= 10 items
mode
string
Allowed values: auto consent cookies cookieless
signup_goal
string
nullable
signin_goal
string
nullable
excluded_countries
Array<string>
<= 20 items

Updated settings

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties