Event Collection API: Purchase Event

The purchase event should be fired when a visitor completes checkout on a product they previously viewed via search.

A purchase event should be sent in the following situations:

• When a user completes checkout, and at least one product in the order received an impression from Eureka search or listing

• Include all purchased product IDs in allPurchasedProducts (even non-Eureka products)

• Only include Eureka-related products in the products array with their tracking data

Endpoint

POST https://eurekaevent.api.useinsider.com/api/v1/event

Payload Fields

The purchase event supports the following properties:

Refer to Common Properties for further details.

Purchase Product Fields

Each product in the products array:

Refer to Common Properties for further details.

Multiple Sources per Product:

Unlike other event types, each product in a purchase event can have its own source. This is because a single order may contain products that were found through different paths (e.g., one through search, another through a category listing).

allPurchasedProducts vs products:

The allPurchasedProducts field should contain the IDs of all products in the order, including those that are not related to Eureka. The products array should only contain the detailed information for products that were accessed through Eureka search or listing pages.

Attribution Window:

When sending data for purchase events, consider the time window your event falls within. Only include values from the predefined windows that encompass the event timeframe. For instance, if an item was added to the cart on the eighth day, you would only send the values for "14", "30", and "90" because those windows include the eighth day.

Source Sanitization:

At the product level, the following legacy source values are automatically converted:

• collection-listing → category-listing

• other → search-listing

• product-detail → search-listing

Advanced Analytics (September, 01 2025 release):

The event now retrieves currentPage and source from the product-level fields instead of the top-level fields. You may continue sending values at the event level for backward compatibility, but it is recommended to update your implementation to the new product-level structure.

Default Values & Fallback Behavior

• product.quantity: Defaults to 1 if 0 or negative

• product.sorting: Defaults to "Relevancy" if empty

• product.source: Sanitized -- collection-listing -> category-listing, other/product-detail -> search-listing

• product.traceId <-> searchSessionId: 3-layer bidirectional fallback: product.traceId -> product.searchSessionId -> event.searchSessionId

Sample Request (Multiple Sources per Product)

In the example below, you see a sample request along with guidance on how to modify 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/cart",
  "userId": "user-12345",
  "platform": "android",
  "campId": 100,
  "variationId": 200,
  "source": "search-listing",
  "attributionWindow": ["session", "1", "7", "30", "90"],
  "searchSessionId": "search-session-abc123",
  "orderId": "order-xyz789",
  "allPurchasedProducts": [
    "product-001",
    "product-002",
    "product-003"
  ],
  "products": [
    {
      "traceId": "search-session-abc123",
      "strategyId": "strategy-id-123",
      "sessionId": "session-id-123",
      "source": "category-listing",
      "id": "product-001",
      "groupCode": "group-1",
      "listValue": "categoryA~categoryB",
      "resultCount": 25,
      "itemsPerPage": 10,
      "totalPages": 3,
      "currentPage": 1,
      "sorting": "PriceDesc",
      "facets": [
        {
          "label": "Fiyat",
          "field": "price",
          "values": ["500", "2000"]
        }
      ],
      "price": 1299.99,
      "convertedPrice": 1199.99,
      "currency": "USD",
      "preferredCurrency": "EUR",
      "clickPosition": 1,
      "displayPosition": 1,
      "quantity": 2,
      "attributionWindow": ["session", "1", "7", "30", "90"]
    },
    {
      "traceId": "search-session-def456",
      "strategyId": "strategy-id-123",
      "sessionId": "session-id-123",
      "source": "search-listing",
      "id": "product-002",
      "groupCode": "group-2",
      "query": "queryA",
      "resultCount": 15,
      "itemsPerPage": 10,
      "totalPages": 2,
      "currentPage": 1,
      "sorting": "MostPopularFirst",
      "facets": [
        {
          "label": "Brand",
          "field": "brand_en",
          "values": ["brandA"]
        }
      ],
      "price": 49.99,
      "convertedPrice": 45.99,
      "currency": "USD",
      "preferredCurrency": "EUR",
      "clickPosition": 2,
      "displayPosition": 2,
      "quantity": 1,
      "attributionWindow": ["session", "1", "7", "30", "90"]
    }
  ],
  "eventType": "purchase",
  "integrationType": "api",
  "createdAt": "2025-11-25T10:50:00Z"
}'