Event Collection API: Product List View Event

Product List View event should be fired when a visitor views a category or brand listing page where products are displayed. This event is used to track impressions on non-search listing pages, such as category and brand pages.

Suggested cases are as follows;

When a user visits a category listing page (e.g., Electronics > Laptops)
When a user applies filters, changes sorting, or navigates tothe next page within a category listing

Endpoint

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

Visit our Postman collection to test this request.

Request Parameters

The Product List View event supports the following properties:

Attribute Name	Type	Validation	Default	Description
referrer	String	Required, url	-	Source URL of the referring page
campId	Integer	-	999999	A unique identifier assigned to a campaign. Refer to common fields for more details.
variationId	Integer	-	999999	A unique identifier assigned to a specific variation within a campaign. Refer to common fields for more details.
source	String	required, oneof= category-listing, brand-listing		Component where the search engine is used
listValue	String	required, oneof= category-listing, brand-listing
userId	String	-	default	Unique identifier of the user. Must not contain spaces. It is expected to be provided for user-based calculations.
platform	String	Required, oneof= - desktop-web - mobile-web - tablet-web - ios - android - other	-	Platform used by the user
integrationType	String	Required, oneof= - api - web	-	Type of integration
traceId	String	Required	-	Unique trace identifier created for the current query. Refer to common fields for more details.
sessionId	String	-	-	Browser/app session identifier
strategyId	String	-	-	Optional strategy identifier
sorting	String	Required	Relevancy	Sorting method used in the search request. It is the type of sorting object of the search response.
resultCount	Integer	Required, unless no result, min=0	-	Number of search results returned
itemsPerPage	Integer	-	-	Number of items per page used in the search request
totalPages	Integer	-	-	Total number of pages returned by the search
currentPage	Integer	-	-	Page number where the search results are displayed
facets	List of facets	-	-	List of facets of the search. Required if any facet selected. Refer to common fields for more details.
products	List of products	Required, min=1	-	List of products returned by the search. Refer to common fields for more details.
eventType	String	required, equals=product-list-view	-	Type of event. Must be product-list-view.
createdAt	String	Required, formatted in RFC3339	If omitted or invalid, the defaults to the current time	Time when the event is created. Refer to common fields for more details.

Each list page request is assigned a uniquely generated traceId.

Sample Requests

In the examples below, we provide sample requests 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.

Hierarchical Category Listing Example

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/category/electronics",
  "source": "category-listing",
  "listValue": "electronics~laptops",
  "userId": "user-12345",
  "platform": "desktop-web",
  "traceId": "trace-abc123",
  "sessionId": "session-abc123",
  "strategyId": "strategy-001",
  "sorting": "PriceAsc",
  "resultCount": 120,
  "itemsPerPage": 24,
  "totalPages": 5,
  "currentPage": 1,
  "integrationType": "api",
  "createdAt": "2026-01-20T14:30:00Z",
  "facets": [
    {
      "label": "Brand",
      "field": "brand_en",
      "values": ["Apple", "Dell"]
    }
  ],
  "products": [
    {
      "id": "product-001",
      "groupCode": "laptop-group-1",
      "price": 999.99,
      "convertedPrice": 949.99,
      "currency": "USD",
      "preferredCurrency": "EUR",
      "position": 1,
      "displayPosition": 1,
      "isMerchandisedItem": false
    },
    {
      "id": "product-002",
      "groupCode": "laptop-group-2",
      "price": 1299.99,
      "convertedPrice": 1249.99,
      "currency": "USD",
      "preferredCurrency": "EUR",
      "position": 2,
      "displayPosition": 2,
      "isMerchandisedItem": false
    }
  ],
  "eventType": "product-list-view"
}'

Flat Category Listing Example

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/category/electronics",
  "source": "category-listing",
  "listValue": "samsung laptops",
  "userId": "user-12345",
  "platform": "desktop-web",
  "traceId": "trace-abc123",
  "sessionId": "session-abc123",
  "strategyId": "strategy-001",
  "sorting": "PriceAsc",
  "resultCount": 120,
  "itemsPerPage": 24,
  "totalPages": 5,
  "currentPage": 1,
  "integrationType": "api",
  "createdAt": "2026-01-20T14:30:00Z",
  "products": [
    {
      "id": "product-001",
      "groupCode": "laptop-group-1",
      "price": 999.99,
      "convertedPrice": 949.99,
      "currency": "USD",
      "preferredCurrency": "EUR",
      "position": 1,
      "displayPosition": 1,
      "isMerchandisedItem": false
    },
    {
      "id": "product-002",
      "groupCode": "laptop-group-2",
      "price": 1299.99,
      "convertedPrice": 1249.99,
      "currency": "USD",
      "preferredCurrency": "EUR",
      "position": 2,
      "displayPosition": 2,
      "isMerchandisedItem": false
    }
  ],
  "eventType": "product-list-view"
}'