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:

Attribute	Type	Description	Example
`channel`	string (uppercase)	The touchpoint where the user interacts with your brand.	`"MOBILE_APP"` `"MOBILE_WEB"` `"WEB"`
`type`	string (uppercase)	The type of the event that takes place when the user interacts with your brand.	`"SEARCH"`
`language`	string (uppercase ISO 639-1)	The language the user is using your app in.	`"DE"` `"EN"` `"FR"`
`currency`	string (uppercase ISO 4217)	The alphabetic currency code of the currency the user is using in your app.	`"EUR"` `"GBP"` `"USD"`
`page`	string	The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice.	`"search page"`
`pos`	string	The name of the point of sale where the interaction with your brand takes place.	`"myretailsite/ireland"` `"spinair.com/france"`
`browser_id`	string	The browser ID.	`"a38b230c-11eb-4cf9-8d5d-274e9f344925"`
`product_name`	string	The product name the guest searched for.	`"airSupport"`
`product_type`	string (uppercase)	The product type the guest searched for.	`"RUNNERS"`

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

Attribute	Type	Description	Example	Required/optional
`channel`	string (uppercase)	The touchpoint where the user interacts with your brand.	`"MOBILE_APP"` `"MOBILE_WEB"` `"WEB"`	Required
`type`	string (uppercase)	The type of the event that takes place when the user interacts with your brand.	`"SEARCH"`	Required
`language`	string (uppercase ISO 639-1)	The language the user is using your app in.	`"DE"` `"EN"` `"FR"`	Required
`currency`	string (uppercase ISO 4217)	The alphabetic currency code of the currency the user is using in your app.	`"EUR"` `"GBP"` `"USD"`	Required
`page`	string	The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice.	`"search page"`	Required
`pos`	string	The name of the point of sale where the interaction with your brand takes place.	`"myretailsite/ireland"` `"spinair.com/france"`	Required
`browser_id`	string	The browser ID.	`"a38b230c-11eb-4cf9-8d5d-274e9f344925"`	Required
`product_name`	string	The product name the guest searched for.	`"DUB-LHR"`	Required
`product_type`	string (uppercase)	The product type the guest searched for.	`"FLIGHT"`	Required
`flight_type`	string (uppercase)	The flight type the guest searched for.	`"OW"` for one way `"RT"` for return	Required
`origin`	string (uppercase)	The IATA code (airport or city) of the origin the guest searched for.	`"DUB"` `"LHR"` `"BCN"`	Required
`destination`	string (uppercase)	The IATA code (airport or city) of the destination the guest searched for.	`"DUB"` `"LHR"` `"BCN"`	Required
`start`	string (ISO 8601) Format: `YYYY-MM-DD’T’hh:mm`	The local departure date and time of the flight the guest searched for.	`"2025-08-21T16:17"`	Required
`end`	string (ISO 8601) Format: `YYYY-MM-DD’T’hh:mm`	The local return date and time of the flight the guest searched for.	`"2025-08-28T10:00"`	Required
`adults`	integer Minimum `0`	The number of adults of the flight the guest searched for.	`2`	Required
`children`	integer Minimum `0`	The number of children of the flight the guest searched for.	`1`	Required
`infants`	integer Minimum `0`	The number of infants of the flight the guest searched for.	`0`	Required
`fare_class`	string (title case)	The class of flight the guest searched for.	`"Economy"` `"Premium Economy"` `"Business"` `"First Class"`	Required
`fare_family`	string (title case recommended)	The fare family of the flight the guest searched for.	`"Economy Plus"` `"Flexi Economy"`	Optional

Example 42. SEARCH event object

RequestResponse

{
    "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

RequestResponse

{
    "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": "2025-01-30T00:00",
    "end": "2025-02-01T00:00",
    "adults": 2,
    "children": 1,
    "infants": 0,
    "fare_class": "Economy",
    "fare_family": "Economy Plus"
}

Do you have some feedback for us?

If you have suggestions for improving this article,