Skip to main content
A site has a handful of switches. Together they say whether the SDK runs at all, whether the engine only watches or also speaks, and which signals it reads. All of them are on the site record, changed in the console or with PATCH /v1/sdk/{id}.

​
enabled

The master switch. With enabled false the settings call answers 418 { enabled: false } and the SDK on every page stops before it connects. Nothing is read, nothing is recorded. Use it to take a site fully offline without removing the tag. Default: true.

​
shadow: watch mode

shadow true is watch mode. The engine reads every visit, recognises every moment, decides, and writes what it would have said, but nothing reaches a visitor. shadow false is active mode: an engage places a card for the visitor. Start every site in watch mode. It is free, it costs the visitors nothing, and after a week the Moments view shows exactly what the site would have said to whom. Turn shadow off when the sentences read right and the facts sheet is complete. The shop-owner explanation of the two modes is in Watch mode; the mechanics are the same on any site. When the record cannot be read the console shows the site as shadow. A screen that cannot read the flag must show the safe state, not the speaking one.

​
card_enabled

Whether the on-page card may be shown at all. Off by default. With shadow false and card_enabled false the engine decides and records as in active mode but never places a card; that is the state for a site that delivers sentences another way (a browser event or a popup tool, see The card) or that only wants the record. With both shadow false and card_enabled true, a card is placed for every engage that has a sentence.

​
The capture toggles

Nine booleans say which signals the SDK sends. All on by default. Turn one off only when a page type cannot tolerate it. The engine is built from all nine together, and a missing channel makes it more cautious, not wrong.

​
vertical: the site type

One of E-commerce, SaaS, Events, Agency, Business services, Local services, Financial services, Industrial, Logistics, Nonprofit, Personal. Detected from the site’s pages when the site is created and editable afterwards. It sets the wording the console uses for “finishing” (an order, a booking, a signup) and tells the engine what a commercial page looks like on this kind of site. A wrong type does not break anything; it makes the reports read oddly.

​
holdout_pct

The share of stuck visitors held back to compare, between 0.05 and 0.5. Described on its own page: The holdout.

​
A sensible sequence

  1. Create the site, install the tag, confirm connected. Watch mode, card off.
  2. Read Moments for a week. Fix the facts sheet where a sentence would have been wrong or missing.
  3. Turn shadow off and card_enabled on. The first sentences go out.
  4. Leave the holdout at its default until the comparison on the store view has thirty visitors in each arm.