Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
PersonalizeCloud Portal
Sitecore Personalize developer documentation
  • Developing with Sitecore Personalize
            • Settings object
                • VIEW event
                • IDENTITY event
                • ORDER_CHECKOUT event
                • ADD event
                • CONFIRM event
                • CHECKOUT event
                • PAYMENT event
                • CLEAR_CART event
                • SEARCH event
                • Custom event
            • Extension data object
            • Personalization data object
        • Troubleshooting
        • Release notes
  1. Event data object
  1. Sitecore Personalize developer documentation
  2. Stream API

SEARCH event

The event data object for a SEARCH event must include all the required attributes for event data objects plus the following attributes:

AttributeTypeDescriptionExample
product_namestringThe product name the guest searched for."airSupport"
product_typestring (uppercase)The product type the guest searched for."RUNNERS"

After you create this event data object, you can optionally extend this event using the extension data object. Then, you can send the event using the [Engage.event()](engage-event.md "Engage.event(type, eventData[, extensionData])") function.

Example 27. SEARCH event object

const eventData = {
    channel: "WEB",
    currency: "EUR",
    pointOfSale: "myretailsite/ireland",
    language: "EN",
    page: "search result page",
    "product_name": "airSupport",
    "product_type": "RUNNERS"
}

Example 28. SEARCH event object for flight search

const eventData = {
  channel: "WEB",
  currency: "EUR",
  pointOfSale: "myretailsite/ireland",
  language: "EN",
  page: "search result page",
  product_name: "DUB-LHR",
  product_type: "FLIGHT",
  flight_type: "RT",
  origin: "DUB",
  destination: "LHR",
  start: "2026-01-30T00:00",
  end: "2026-02-01T00:00",
  adults: 2,
  children: 1,
  infants: 0,
  fare_class: "Economy",
  fare_family: "Economy Plus"
};

const extensionData = {
  onSale: false
};

engage.event("SEARCH", eventData, extensionData);
If you have suggestions for improving this article, let us know!

Documentation Assistant

This assistant uses AI to generate responses based on Sitecore documentation. While it has access to official sources, answers may be incomplete or inaccurate and should not be considered official advice or support.
Powered by
k
kapa.ai
Protected by reCAPTCHA

© Copyright 2026, Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use