The add to cart event should be fired when a visitor adds an item to the cart from search results.
Endpoint
Visit our Postman collection to test this request.
Request Parameters
The add to cart event supports the following properties:
Attribute Name | Type | Validation | Default | Description |
|---|---|---|---|---|
referrer | String | Required, url | - | Source URL of the referring page |
campId | Integer | - | 999999 | The campId serves as a unique identifier. Refer to common fields for more details. |
variationId | Integer | - | 999999 | The variationId represents the unique identifier for a specific campaign variation. Refer to common fields for more details. |
source | String | oneof= | search-listing | Source origin where the event triggered |
integrationType | String | Required, | - | Type of integration |
platform | String | Required, - tablet-web | - | Platform used by the user. Refer to common fields if you want to use other. |
userId | String | - | default | Unique identifier of the user. It is expected to provide for user-based calculations. |
product | List of Product | Required | - | The product clicked by the user. Refer to common fields for more details. |
eventType | String | Required, | - | Type of event |
createdAt | String | Required, formatted in RFC3339 | If omitted or invalid, it defaults to the current time | Time when the event is created. Refer to common fields for more details. |
If your integration was implemented before the Advanced Analytics September 01, 2025, release, please note that new fields have been added to the expected product payload. Following this release, the event now retrieves currentPage and related details from product-level fields instead of top-level fields. In addition, the product object has been enriched with several new fields.
For backward compatibility, you may continue sending these values at the event level. However, it is strongly recommended to update your implementation to the new product-level structure to ensure full alignment with the latest version and to benefit from more comprehensive analytics.
You can review the full list of changes on the Common Properties page.
Sample Request
In the example below, you see a sample request along with guidance on modifying the necessary fields. This will help you seamlessly integrate and make the most of the provided configuration.
Before usage, modifying the values such as x-auth-token and x-partner-config-key is essential.
curl --location --request POST 'https://eurekaevent.api.useinsider.com/api/v1/events' \
--header 'x-auth-token: YOUR_AUTH_TOKEN' \
--header 'x-partner-config-key: YOUR_PARTNERID-YOUR_LOCALE' \
--header 'Content-Type: application/json' \
--data-raw '{
"referrer": "https://example.com/search-results",
"source": "product-detail",
"userId": "user-12345",
"platform": "ios",
"campId": 999999,
"variationId": 999999,
"product": {
"id": "product-001",
"groupCode": "laptop-group-1",
"query": "laptop",
"price": 1299.99,
"convertedPrice": 1199.99,
"currency": "USD",
"preferredCurrency": "EUR",
"clickPosition": 3,
"displayPosition": 3,
"quantity": 2,
"resultCount": 25,
"itemsPerPage": 10,
"totalPages": 3,
"facets": [
{
"label": "Price",
"field": "price_en",
"values": ["500", "2000"]
},
{
"label": "Brand",
"field": "brand_en",
"values": ["16GB"]
}
],
"sorting": "Relevancy",
"currentPage": 1,
"traceId": "search-session-abc123",
"strategyId":"strategy-id-123",
"sessionId":"session-id-123",
"attributionWindow": ["7", "30", "90"]
},
"eventType": "add-to-cart",
"integrationType": "api",
"createdAt": "2025-11-25T10:40:00Z"
}'