Skip to content

Search Tracking

To populate the dashboard with information about user behavior and search performance, Ecommerce Search can be configured to track search events. The tracking will store search events from the search request and response in the event history. The event history can then be used to generate dashboard reports.

Sampling Rate

The sampling rate of search tracking can be configured in the settings through the UI. It can also be set on the /api/settings/general endpoint of the Admin API.


If the sampling rate is set to 0, search tracking is completely disabled.

Tracking Sessions

To support advanced analysis of the event history, a session ID should be included in search requests. This session ID should come from the customer solution.

Session IDs are different from user IDs. User IDs are long-lived, whereas session IDs should be short-lived. Session IDs are used to link API actions performed by the same user over a time span (e.g. 30 minutes).

There are no requirements for the creation of session IDs. A session ID can be in the form of a UUID, GUID, snowflake, or any other unique identifier. It must however be distinct, and consistent for the duration of a session.

Session IDs are not created or managed by Ecommerce Search. They should be kept in local browser storage and adhere the following guidelines:

  1. A session ID should be generated upon entering the site without an existing session ID.
  2. Session IDs should be stored in sessionStorage to ensure that they are properly deleted.
  3. Session IDs should not have a TTL, as they should only be cleared at the end of sessions.


Session IDs are optional, but are a requirement for the generation of findability reports.