Skip to main content

Configuration

The SDK asks GET /v1/config?key=pk_live_… once per page load and waits up to 1.5 seconds for the answer before going on with the defaults; a configuration that arrives later still applies from then on. The answer is cacheable for five minutes.

{
"click_ids": [
{ "key": "gclid", "platform": "google", "read_from": "url", "valid_days": 90, "consent_category": "ads" },
{ "key": "fbclid", "platform": "meta", "read_from": "url", "valid_days": 7, "consent_category": "ads" }
],
"banner_exempt": ["subscribed_newsletter", "entered_details", "placed_basket", "Newsletter Signup"],
"session_timeout_minutes": 30,
"link_max_age_seconds": 120,
"shop_domains": ["shop.summerfest.nl", "eventix.shop"],
"owner_paths": [{ "prefix": "/summer-fest/", "owner_ref": "evx:…" }]
}
FieldMeaning
click_idsWhich ad click ids to read, from the address or a cookie, how long they stay valid and which consent they need. Adding a platform is a row in the service's registry, never an SDK release.
banner_exemptTrack names sent before consent, without an anonymous id: the banner-exempt activities and the names the owner's rules map onto one.
session_timeout_minutesIdle time that ends a session.
link_max_age_secondsHow old a shop link may be for its id to be adopted.
shop_domainsLinks to these domains carry the anonymous id.
owner_pathsWith a group key: which organiser a page belongs to, by path prefix. A data-evx-owner attribute on the page wins.

The endpoint takes a browser key only.