Event Collection API: Common Properties

The Event Collection API has established a set of common data types for event properties. This approach ensures consistency and clarity across various event payloads. These shared data types serve as standardized structures that can be reused in different contexts, promoting a consistent approach to data representation.

Event Payload Properties

userId

Every user must be assigned a unique identifier, tailored to your specific criteria and definitions. If you can obtain the value using the Insider JavaScript object, please provide that value. If it's not retrievable, send a userId using characters from the base64 scheme without any symbols.

It is available in local storage with the name spUID, or you can use Insider.getUserId() method on the console.

campId

The campId serves as a unique identifier. 

By default, it is set to 999999. If you want to use a different value, contact the Insider One team.

variantId

The variationId represents the unique identifier for a specific campaign variation.

By default, it is set to 999999. If you want to use a different value, contact the Insider One team.

searchSessionId

For uniqueness, assign a distinctive identifier to each search session. It's important to distinguish between web sessions and search sessions. Unlike a web session, which encompasses your entire browsing activity on a website, a search session focuses on a single search you make.

It should be the base64-encoded form of {userid}+{~}+{search query}+{~}+{ISO 8601 Date and time in UTC}.

• Recommended value:  YXBwbGV+MjAyMy0xMi0xNFQxMToyMDoyOFo= (base64 encoded form of query and time combination)
• Not recommended value: apple~2023-12-14T11:20:28Z (not base64 encoded)

Even if the query text and timestamp are the same, search sessions are generated uniquely per user. This ensures that analytics, personalization, and tracking do not mix results across different users.

The following table illustrates the uniqueness of the searchSessionId:

For another example, suppose user Jordan interacts with the search results. After searching for "Mike shoes", Jordan clicks on a product, adds an AeroJordan item to the cart, and eventually completes the purchase.

All subsequent event payloads (click, add-to-cart, purchase) must reference the previously generated searchSessionId (Sm9yZGFuK05pa2Ugc2hvZXMrMjAyNS0wOC0yMFQxMTozMDow). This ensures that the entire sequence of actions is consistently tied back to the original search session.

Preferred Currency

Specifies the base (reference) currency used for analytics and reporting. Although product prices may exist in multiple currencies, the preferredCurrency ensures consistency by defining the currency in which analytics are presented.

Converted Price

Represents the product price converted from its original source currency into the preferredCurrency. This provides a single unified value, regardless of the original currency.

Source Field

Indicates the component in which the search engine is used. This field helps identify the context of the search interaction. The possible values for this field are search-popup, search-listing, and collection-listing.

Platform

This field specifies the platform on which the application is running. The possible values for this field are desktop-web, mobile-web, ios, and android. If your use case does not fit into these predefined values, you may provide a custom standardized value.

Integration Type

This field specifies the type of user who is accessing the application. The possible values for this field are api, and web.

Search Position

Specifies the product's position on the current page when it is first displayed.

Click Position 

Specifies the position of the product on the current page when it is clicked.

Created At

Timestamp indicating when the event was created.

Must follow RFC 3339 date-time format.

Includes date, time, and timezone offset or Z for UTC.

Event Type

This field specifies the type of event that is being tracked. The possible values for this field are search, product-click, add-to-cart, and purchase.

Attribution Window

The attribution window is the time frame during which a user’s actions can be traced back to the original source that initiated those actions. For example, if a user searches for a product on Eureka and subsequently clicks a product, adds it to their cart, and completes a purchase, the attribution window defines how long these actions can be attributed to the initial search query.

The sample attribution window values you see are predefined for metric calculations. When sending events, such as add-to-cart or purchase, consider the time window during which the event occurs. Only include values from the predefined windows that cover the event’s timestamp.

For example, if an item was added to the cart on the eighth day, you should send only the values for 14, 30, and 90 days, as these windows include the eighth day.

Sample Values: ["session", "1", "7", "14", "30", "90"]

According to Google Analytics, a session is a group of user interactions with a website that occur within a defined time frame. A session starts when the user first lands on the site and ends based on user activity patterns.

A single user can initiate multiple sessions, occurring within the same day or across days, weeks, or months. Once a session ends, a new session can begin. Time-based session expiration typically follows three rules:

• 30 minutes of inactivity
• At midnight — Not applicable to Insider sessions
• Campaign change — Not applicable to Insider sessions

These definitions help ensure consistent and accurate attribution for analytics and performance measurement.

Facet

The facet field has the following properties:

Sorting

The sorting parameter in the search event can only have one of the values from the predefined sorting types. It needs to be added to the event payload based on the currently selected search result.

• Relevancy
• PriceAsc
• PriceDesc
• MostPopularFirst
• BestRatedFirst
• MostRatedFirst
• NewestFirst
• MostFavoriteFirst
• MostDiscountedFirst

Product

The product field has the following properties:

Event Support Matrix

The Event Support Matrix table provides a structured reference for all parameters available within the product field across different event payloads. Each row represents a specific parameter, along with the supported event types: Search Event, Product Click Event, Add to Cart Event, and Purchase Event. The check marks indicate whether a parameter is included in a given event type:

Advanced Analytics – Updates Introduced in the September 01, 2025, Release

Review and adopt these changes to improve the completeness and accuracy of analytics. Event-level values remain supported for backward compatibility.

groupCode Field

The groupCode field is a newly introduced field in this release. It needs to be sent under the product object.

If the catalog supports a groupCode, you must provide it. Without groupCode, group-level analytics will not be available in your analytics page.

Product Field

The product object has been expanded with additional optional fields by event type to provide richer context and analytics:

For Search Event

• groupCode
• convertedPrice
• preferredCurrency
• searchPosition

For Product Click Event

• groupCode
• convertedPrice
• preferredCurrency
• searchPosition
• clickPosition
• query
• facets
• sorting
• resultCount
• itemsPerPage
• totalPages
• currentPage

For Add to Cart Event

• groupCode
• convertedPrice
• preferredCurrency
• searchPosition
• clickPosition
• query
• facets
• sorting
• resultCount
• itemsPerPage
• totalPages
• currentPage
• attributionWindow

For Purchase Event

• groupCode
• convertedPrice
• preferredCurrency
• searchPosition
• clickPosition
• query
• facets
• sorting
• resultCount
• itemsPerPage
• totalPages
• currentPage
• attributionWindow
• source

Position Field

The position value is split into two separate fields: searchPosition and clickPosition.

You can find the detailed definitions in the related section:

• searchPosition
• clickPosition

currentPage Field

The currentPage field has been relocated to the products object and is available for product click, add-to-cart, and purchase event types.

preferredCurrency Field

The preferredCurrency is a newly introduced field in this release.

convertedPrice Field

The convertedPrice is a newly introduced field in this release.