Web Analytics

Replace the workspace's web analytics settings

POST https://demo.notifuse.com/api/workspaces.setWebAnalyticsSettings

Gated by the web_analytics write permission (like blog settings, members manage the feature without workspace write access). The attribution filters version is recomputed server-side. Passing null settings clears the configuration.

Writing an identified visitor's goals and navigation to their contact timeline is not configured here and has no setting: calling identify() with an HMAC is the opt-in, because minting that credential requires the workspace secret.

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Body application/json

workspace_id string required
settings object | null
Show 11 child attributes Hide 11 child attributes
enabled boolean
allowed_domains string[]

Origins allowed to send beats ("example.com", "*.example.com"); empty allows all.

bounce_threshold_seconds integer

Sessions with less engaged time count as bounces (default 10).

filters object[]
Show 9 child attributes Hide 9 child attributes
id string required
name string required
priority integer required
Min 0 Max 1000
order integer
tags string[]
conditions object[] required
Show 3 child attributes Hide 3 child attributes
field string required
operator string required
Options equals, not_equals, contains, not_contains, is_empty, is_not_empty, regex
value string
operations object[] required
Show 3 child attributes Hide 3 child attributes
dimension string required
action string required
Options set_value, unset_value, set_default_value
value string
enabled boolean required
version string
filters_version string read-only
custom_dimension_labels map<string, string>
identify_from_email_links boolean

Adds a signed identity to the links of tracked emails, so a recipient who clicks one is recognised on landing without any code on the customer's site, and their visit is tied to their contact record. Off by default: unlike identify(), which the customer's own server calls with their own secret, this credential is minted by Notifuse for every recipient of every tracked send, so it is theirs to ask for.

geo_enabled boolean
geo_store_city boolean
geo_store_region boolean
geo_coordinates_precision integer
Min 0 Max 2

Response

200 Settings updated
400 Validation failed
403 The caller lacks web_analytics write, returned with the missing resource named in the error message.