Eureka SDK Log Collection Methods

All Eureka SDK log collection methods are accessible under the Insider.eureka.track namespace:

Two types of logs are available:

• Manually Collected Logs: You must call Insider.eureka.track.* methods for these events (page view, search, click, add-to-cart on listing pages).

• Automatically Collected Logs: Add-to-cart on the Product Details Page (PDP) and purchase events are collected automatically. You do not need to call any track method for these.

Manually Collected Logs

For Category and Brand Listing Pages

For Search Popup and Search Listing Pages

Every time a user interacts with filters (facets), pagination, or sorting, the corresponding track method must be called again with the updated data. For example, if a user changes sorting on a category listing page, call productListingView again with the new results.

productListingView

Call this when a user views a category or brand listing page. Also call it again when the user changes sorting, applies filters, or navigates to a different page.

• Method: Insider.eureka.track.productListingView(campId, listingPageName, payload)

• Payload fields

Example:

Insider.eureka.track.productListingView(470, 'categoryA~categoryB', {
    pagination: {
        resultCount: 84,
        itemsPerPage: 24,
        totalPages: 4,
        currentPage: 1,
    },
    sorting: 'Relevancy',
    facets: [
        { label: 'Price', field: 'price_en', values: ['500', '2000'] },
    ],
    products: [
        { id: 'product-001', groupCode: 'group-1', price: 1299.99, displayPosition: 1 },
        { id: 'product-002', groupCode: 'group-2', price: 899.99, displayPosition: 2 },
    ],
});

Example - Brand listing (set source):

Insider.eureka.track.productListingView(470, 'BrandName', {
    source: 'brand-listing',
    pagination: { resultCount: 50 },
    products: [
        { id: 'product-001', price: 999.99, displayPosition: 1 },
    ],
});

search

Call this when a user performs a search. Also, call it again when the user changes sorting, applies filters, or navigates to the next page within the search results.

• Method: Insider.eureka.track.search(campId, query, payload)

• Payload Fields

Example:

Insider.eureka.track.search(999999, 'queryA', {
    pagination: {
        resultCount: 25,
        itemsPerPage: 24,
        totalPages: 2,
        currentPage: 1,
    },
    sorting: 'Relevancy',
    products: [
        { id: 'product-001', price: 999.99, displayPosition: 1 },
        { id: 'product-002', price: 1099.99, displayPosition: 2 },
    ],
});

productClickAfterListing

Call this when a user clicks on a product from a category or brand listing page.

• Method: Insider.eureka.track.productClickAfterListing(campId, listingPageName, payload)

• Payload Fields

SDK add-to-cart methods do not trigger a click event automatically. When a user clicks the "Add to Cart" button directly on a product card in the listing page, you must call productClickAfterListing first, then productAddToCartAfterListing.

displayPosition refers to the position where the user first saw the product for a given listing. After facet or sorting changes, the same product may appear in a different position. In this case, displayPosition (original position) and clickPosition (position at the time of click) may differ.

Example:

Insider.eureka.track.productClickAfterListing(470, 'categoryA~categoryB', {
    pagination: { resultCount: 84 },
    product: {
        id: 'product-001',
        groupCode: 'group-1',
        price: 1299.99,
        displayPosition: 3,
    },
});

productClickAfterSearch

Call this when a user clicks on a product from the search results page.

• Method: Insider.eureka.track.productClickAfterSearch(campId, query, payload)

• Payload Fields:

SDK add-to-cart methods do not trigger a click event automatically. When a user clicks the "Add to Cart" button directly on a product card in the search results page, you must call productClickAfterSearch first, then productAddToCartAfterSearch.

displayPosition refers to the position where the user first saw the product for a given query. After facet or sorting changes, the same product may appear in a different position. In this case, displayPosition (original position) and clickPosition (position at the time of click) may differ.

Example:

Insider.eureka.track.productClickAfterSearch(999999, 'queryA', {
    pagination: { resultCount: 25 },
    product: {
        id: 'product-001',
        price: 999.99,
        displayPosition: 2,
        clickPosition: 3,
    },
});

productAddToCartAfterListing

Call this when a user adds a product to cart directly from a category or brand listing page (not from the Product Details Page).

• Method: Insider.eureka.track.productAddToCartAfterListing(campId, listingPageName, payload)

• Payload Fields:

You must call productClickAfterListing before calling this method.

Add-to-cart on the Product Details Page is collected automatically. Do not call this method on the Product Details Page.

Insider.eureka.track.productAddToCartAfterListing(470, 'categoryA~categoryB', {
    pagination: { resultCount: 84 },
    product: {
        id: 'product-001',
        price: 1299.99,
        displayPosition: 3,
    },
});

productAddToCartAfterSearch

Call this when a user adds a product to cart directly from the search results page (not from the Product Details Page).

• Method: Insider.eureka.track.productAddToCartAfterSearch(campId, query, payload)

• Payload Fields:

You must call productClickAfterSearch before calling this method.

Add-to-cart on the Product Details Page is collected automatically. Do not call this method on the Product Details Page.

Example:

Insider.eureka.track.productAddToCartAfterSearch(999999, 'queryA', {
    pagination: { resultCount: 25 },
    product: {
        id: 'product-001',
        price: 999.99,
        displayPosition: 2,
    },
});

Automatically Collected Logs

The following events are collected automatically. You do not need to call any track method for these.

What you need to do:

Call the click track methods on listing and search pages whenever an item is clicked. For add-to-cart, call the track method only when the user adds a product to cart directly from the listing or search page (e.g. via an "Add to Cart" button on the product card). We handle add-to-cart on the Product Details Page and purchase events automatically.

Important Rules

• Re-call on user interactions: Every time a user changes sorting, applies filters (facets), or uses pagination, you must call the corresponding track method again with the updated data.

• Click before Add to Cart: Always call the click method (productClickAfterListing or productClickAfterSearch) before calling the add-to-cart method. The add-to-cart method does not trigger a click event automatically.

• Product Details Page handling: Add-to-cart on the Product Details Page and purchase events are automatically collected. Do not call track methods for these scenarios. Only call track methods on listing and search pages.

• traceId on Product Details Page: If you need to send a click or add-to-cart log from the Product Details Page (instead of the listing/search page), you must provide the traceId in the payload. On listing/search pages, traceId is managed automatically.

TraceId

traceId is a unique identifier used to deduplicate events and ensure they are counted correctly in analytics.

For example, when a user searches for "queryA" and sees 10 products, the search event sends all 10 products. Each of these is stored as a separate record, but because they share the same traceId, Eureka Analytics groups them and counts them as a single search action.

The same applies to listing pages: when a category page shows 25 products, they all share the same traceId and are counted as one page view in the analytics dashboard.

How the SDK manages traceId automatically

In most cases, you do not need to provide traceId; the SDK generates and reuses it automatically

Generate a traceId:

const traceId = Insider.eureka.track._generateTraceId();

Example - Click on Product Details Page with stored traceId:

Insider.eureka.track.productClickAfterListing(campId, 'categoryA~categoryB', {
    traceId: storedTraceId,  // retrieved from SDK _generateTraceId method
    pagination: { resultCount: 84 },
    product: {
        id: 'product-001',
        price: 1299.99,
        displayPosition: 3,
    },
});

On listing/search pages, traceId is handled automatically. On the Product Details Page, if no traceId is provided on the Product Details Page, the SDK generates a new one, meaning the event will be counted as a separate action instead of being grouped with the originating search or listing.

Source Values

The source field indicates which page type the log comes from. If not provided, the SDK uses default values.

When to override

• For brand listing pages, set source: 'brand-listing' in the payload of listing methods.

• For search popup, set source: 'search-popup' in the payload of search methods.

Example:

// Brand listing page view
Insider.eureka.track.productListingView(470, 'BrandName', {
    source: 'brand-listing',
    products: [{ id: 'product-001', price: 999.99 }],
    pagination: { resultCount: 50 },
});

// Search in popup
Insider.eureka.track.search(999999, 'queryA', {
    source: 'search-popup',
    products: [{ id: 'product-001', price: 999.99 }],
    pagination: { resultCount: 10 },
});

Validations

Track methods validate the payload before sending. If validation fails, a warning is logged.

Validation Error Message Format

{fieldPath} must be {expectedType} for log type {eventType}

Examples:

• products[0].id must be string for log type collection

• product.price must be number for log type product-click