Skip to content

How-to

Events and capture settings

Download Markdown

Checked against the product’s code on 7 November 2026.

Open Insights > Events & Capture. An event definition gives a recorded action a name and meaning. It does not make anything on the site send that action.

  1. Open Catalog.
  2. Choose New event.
  3. Enter Label.
  4. Review Event name (snake_case).
  5. Add What it means (optional) if a description would help.
  6. Review Count by default.
  7. Review Intended weight. This does not change the affinity engine’s active tuning.
  8. If the event carries a property, choose + Add a property.
  9. Enter that property’s key.
  10. Choose its type. Repeat the property steps for any other details carried with the event.
  11. Review any value source.
  12. Choose Preview.
  13. Read what will be recorded.
  14. Choose Define event if the preview matches your intent.
  15. Read the result, which says the event is in the catalog.

An event can be listed before anything on the site sends it. It collects nothing until something does. Use Composer tracking for a supported page action, configure automatic capture or send it from site code.

To manage an existing event:

  1. Open the event on Catalog.
  2. Choose Enable this event, Disable this event or Archive.
  3. Read the prepared change.
  4. Approve only the intended action.

Archiving retires the definition and deletes nothing already recorded; other senders can still record the same event. To bring an archived event back, undo the archive from the activity log. Rename appears on events you defined and changes only the words on screen. A definition is not a firewall that rejects every incoming event with another name.

After publishing the page that sends an event, ask the copilot whether it has arrived, such as “Has demo_request arrived in the last 30 minutes?” It looks back over events already recorded, for 30 minutes unless you name another period of up to 24 hours. Name a page to check only that page. It does not wait or keep watching.

When the event has arrived, the answer gives the count and the time of the newest one, in UTC. When it has not, the answer says the event is switched off or not defined, or asks you to open the published page, do the action once and ask again. Visitors who refused analytics or send Global Privacy Control are never counted, so an answer that nothing arrived does not prove that nobody did the action.

Tab What to review
Query parameters Extra arrival parameter names to capture. Keep personal or secret values out of URLs.
Automatic capture Section views, clicks inside sections, outbound clicks, file downloads, scroll depth, site search, form engagement and time on the page.
Needs review Arriving event types that have no adopted definition.
Capture health Collection limits and reported dropped events.

A removed query name stops being stored as soon as you approve, on every page view, including one your own code sends. Added names reach visitors as pages refresh. On the visitor-data page-view path, campaign tags and click identifiers containing an email address are left out, and a referrer’s path and query are not kept. New order attribution also leaves out email-like values from arrival tags and removes them from recorded arrival addresses. This does not clean attribution already stored on orders. Declared values containing an email address or a long run of digits are dropped from the page-view record as well as the visitor traits.

Editors and Admins can choose extra values to record from a visitor’s arrival address. Add only names you intend to collect; keep personal and secret values out of links.

  1. Open Query parameters.
  2. Review the names already listed.
  3. Enter an intended name in Add a parameter, such as promo.
  4. Choose + Add. Repeat for each additional name.
  5. Choose Save changes.
  6. Read Approval required, including the added and removed names and who the values are captured for.
  7. Choose Approve and apply only if the list is right.
  8. Read the saved receipt.

The list accepts up to ten names, each 1 to 32 lowercase letters, digits or underscores. utm_source, utm_medium, utm_campaign, click identifiers and the page’s own path, ref, pl and r cannot be added here.

To stop collecting an extra parameter, use its remove button, then save and approve the revised list. An empty list turns extra-parameter capture off. The receipt’s Undo restores the previous list. The collection and delivery limits above still apply. You can also ask the copilot to change the list; see Event capture requests.

  1. Open Insights.
  2. Open Events & Capture.
  3. Open Automatic capture.
  4. Find the card for the kind of action you want to stop collecting.
  5. Choose Disable.
  6. Read Stop collecting this on the live site?.
  7. Choose Approve & disable if that is the intended change.

To stop recording search terms, use these steps on the Site search card.

Automatic capture changes ask for your approval, apply when pages load the updated capture settings and still follow each visitor’s analytics consent. An already open page or an older stored page copy can keep the earlier settings. Native form engagement omits submitted field values; the form inbox is a separate record that can hold those values. Search capture can include the search text.

Unknown event types can already be recorded before you add their definitions to the catalog. Capture health reports what reached its reporting path; it does not guarantee that a page which closed early reported every dropped attempt. See the event reference for the supplied event names.