Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
PersonalizeCloud Portal
Sitecore Personalize developer documentation
  • Developing with Sitecore Personalize
        • Authentication
        • Base URL
        • Retrieve the browser ID
            • IDENTITY event
            • SEARCH event
            • ADD event
            • ADD event for flights
            • ADD event for ancillary product
            • ADD_CONSUMERS event
            • ADD_CONTACTS event
            • CONFIRM event
            • CONFIRM event for flights
            • CHECKOUT event
            • ORDER_CHECKOUT event
            • CLEAR_CART event
            • PAYMENT event
            • Custom event
        • Sending orders
        • Cart abandonment
        • Send additional event data
        • Troubleshooting
  1. Sending events
  1. Sitecore Personalize developer documentation
  2. Stream API

SEARCH event

The SEARCH event captures the user's action of searching for a product. You must send the SEARCH event to Sitecore Personalize when the search results page loads.

To send a SEARCH event, use the following required attributes:

AttributeTypeDescriptionExample
channelstring (uppercase)The touchpoint where the user interacts with your brand.
  • "MOBILE_APP"
  • "MOBILE_WEB"
  • "WEB"
typestring (uppercase)The type of the event that takes place when the user interacts with your brand."SEARCH"
languagestring (uppercase ISO 639-1)The language the user is using your app in.
  • "DE"
  • "EN"
  • "FR"
currencystring (uppercase ISO 4217)The alphabetic currency code of the currency the user is using in your app.
  • "EUR"
  • "GBP"
  • "USD"
pagestringThe name of the webpage where the interaction with your brand takes place.

This is a custom value of your choice.
"search page"
posstringThe name of the point of sale where the interaction with your brand takes place.
  • "myretailsite/ireland"
  • "spinair.com/france"
browser_idstringThe browser ID."a38b230c-11eb-4cf9-8d5d-274e9f344925​"
product_namestringThe product name the guest searched for."airSupport"
product_typestring (uppercase)The product type the guest searched for."RUNNERS"

To send a SEARCH event for a flight search, use the following attributes:

AttributeTypeDescriptionExampleRequired/optional
channelstring (uppercase)The touchpoint where the user interacts with your brand.
  • "MOBILE_APP"
  • "MOBILE_WEB"
  • "WEB"
Required
typestring (uppercase)The type of the event that takes place when the user interacts with your brand."SEARCH"Required
languagestring (uppercase ISO 639-1)The language the user is using your app in.
  • "DE"
  • "EN"
  • "FR"
Required
currencystring (uppercase ISO 4217)The alphabetic currency code of the currency the user is using in your app.
  • "EUR"
  • "GBP"
  • "USD"
Required
pagestringThe name of the webpage where the interaction with your brand takes place.

This is a custom value of your choice.
"search page"Required
posstringThe name of the point of sale where the interaction with your brand takes place.
  • "myretailsite/ireland"
  • "spinair.com/france"
Required
browser_idstringThe browser ID."a38b230c-11eb-4cf9-8d5d-274e9f344925​"Required
product_namestringThe product name the guest searched for."DUB-LHR"Required
product_typestring (uppercase)The product type the guest searched for."FLIGHT"Required
flight_typestring (uppercase)The flight type the guest searched for.
  • "OW" for one way
  • "RT" for return
Required
originstring (uppercase)The IATA code (airport or city) of the origin the guest searched for.
  • "DUB"
  • "LHR"
  • "BCN"
Required
destinationstring (uppercase)The IATA code (airport or city) of the destination the guest searched for.
  • "DUB"
  • "LHR"
  • "BCN"
Required
startstring (ISO 8601)

Format: YYYY-MM-DD’T’hh:mm
The local departure date and time of the flight the guest searched for."2026-08-21T16:17"Required
endstring (ISO 8601)

Format: YYYY-MM-DD’T’hh:mm
The local return date and time of the flight the guest searched for."2026-08-28T10:00"Required
adultsinteger

Minimum 0
The number of adults of the flight the guest searched for.2Required
childreninteger

Minimum 0
The number of children of the flight the guest searched for.1Required
infantsinteger

Minimum 0
The number of infants of the flight the guest searched for.0Required
fare_classstring (title case)The class of flight the guest searched for.
  • "Economy"
  • "Premium Economy"
  • "Business"
  • "First Class"
Required
fare_familystring (title case recommended)The fare family of the flight the guest searched for.
  • "Economy Plus"
  • "Flexi Economy"
Optional

To send a SEARCH event, use the following attributes:

AttributeTypeDescriptionExampleRequired/optional
channelstring (uppercase)The touchpoint where the user interacts with your brand.
  • "MOBILE_APP"
  • "MOBILE_WEB"
  • "WEB"
Required
typestring (uppercase)The type of the event that takes place when the user interacts with your brand."SEARCH"Required
languagestring (uppercase ISO 639-1)The language the user is using your app in.
  • "DE"
  • "EN"
  • "FR"
Required
currencystring (uppercase ISO 4217)The alphabetic currency code of the currency the user is using in your app.
  • "EUR"
  • "GBP"
  • "USD"
Required
pagestringThe name of the webpage where the interaction with your brand takes place.

This is a custom value of your choice.
"search page"Required
posstringThe name of the point of sale where the interaction with your brand takes place.
  • "myretailsite/ireland"
  • "spinair.com/france"
Required
browser_idstringThe browser ID."a38b230c-11eb-4cf9-8d5d-274e9f344925​"Required
product_namestringThe product name the guest searched for."DUB-LHR"Required
product_typestring (uppercase)The product type the guest searched for."FLIGHT"Required
flight_typestring (uppercase)The flight type the guest searched for.
  • "OW" for one way
  • "RT" for return
Required
originstring (uppercase)The IATA code (airport or city) of the origin the guest searched for.
  • "DUB"
  • "LHR"
  • "BCN"
Required
destinationstring (uppercase)The IATA code (airport or city) of the destination the guest searched for.
  • "DUB"
  • "LHR"
  • "BCN"
Required
startstring (ISO 8601)

Format: YYYY-MM-DD’T’hh:mm
The local departure date and time of the flight the guest searched for."2026-08-21T16:17"Required
endstring (ISO 8601)

Format: YYYY-MM-DD’T’hh:mm
The local return date and time of the flight the guest searched for."2026-08-28T10:00"Required
adultsinteger

Minimum 0
The number of adults of the flight the guest searched for.2Required
childreninteger

Minimum 0
The number of children of the flight the guest searched for.1Required
infantsinteger

Minimum 0
The number of infants of the flight the guest searched for.0Required
fare_classstring (title case)The class of flight the guest searched for.
  • "Economy"
  • "Premium Economy"
  • "Business"
  • "First Class"
Required
fare_familystring (title case recommended)The fare family of the flight the guest searched for.
  • "Economy Plus"
  • "Flexi Economy"
Optional

Example 42. SEARCH event object

{
    "channel": "MOBILE_APP",
    "type": "SEARCH",
    "language": "EN",
    "currency": "EUR",
    "page": "search page",
    "pos": "myretailsite/ireland",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
    "product_name": "airSupport",
    "product_type": "RUNNERS"
}

Example 43. SEARCH event object for flight search

{
    "channel": "MOBILE_APP",
    "type": "SEARCH",
    "language": "EN",
    "currency": "EUR",
    "page": "search page",
    "pos": "spinair.com/france",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
    "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"
}
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