Skip to main content
Users
CloudPortalLogin
  • Powered byPowered by
Developing with Sitecore Personalize
Data privacy
Before you start sending data
Integrating with Sitecore Personalize
Stream API
Personalize API Flow execution
REST APIs
  • Sitecore Personalize for developers
  • Stream API
  • Sitecore Engage SDK reference
  • Objects
  • Event data object
  • SEARCH event

SEARCH event

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

Attribute

Type

Description

Example

product_name

string

The product name the guest searched for.

"airSupport"

product_type

string (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() function.

Example 27. SEARCH event object
RequestResponse
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
RequestResponse
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: "2025-01-30T00:00",
  end: "2025-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);


Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2025 Sitecore