On this page
This checklist lists all Personalization implementation steps and provides pointers to help you complete a successful implementation. You can read more about each step in the dedicated guides included in Personalizing Results.
Gathering user data
The first step to an impactful Personalization implementation is gathering the right data about your users. When your users engage in specific behaviors, you need to send Algolia events describing these behaviors. Algolia then uses these events to build individual user affinity profiles. Before beginning to send events, it’s best to analyze which behaviors your users take and creating a plan for the corresponding events you’ll send.
You’ve analyzed which user behaviors are meaningful for your business objectives
- You’ve made a comprehensive list of behaviors your users take that signal their affinities.
- You’ve classified behaviors as
- You’ve classified behaviors as search-related or not.
- You’ve classified behaviors as item-based or category-based.
- You’ve used the event naming guidelines to develop a consistent set of names for the events corresponding to the behaviors.
You’re sending valid events that capture all necessary information
- All your events include a unique
userTokenfor the user engaging in the behavior.
- You are using
conversionevents for the appropriate behavior.
- All your events include a valid
eventNameusing the event naming guidelines.
- All your events include the index name where you’ve declared the applicable facets as
- If you’re sending events related to a search, you’ve included the
- If you’re sending item-based events, you’ve included the relevant
- If you’re sending category or filter-based events, you’ve included the relevant
- Optional but recommended: you’ve included the
timestampfor when the behavior occurred.
You can use the Insights log debugger in your dashboard to monitor the received events and ensure that none of them are missing fields or returning errors.
Configuring your Personalization strategy
The Personalization strategy drives how Algolia computes user affinity profiles using the events you sent. You can configure the Personalization strategy directly from your Algolia dashboard or using the API clients. We recommend using the dashboard since it provides a visual simulator to simulate and explain your strategy’s effects.
You’ve defined a valid Personalization strategy
- You’ve included and weighted events in your strategy.
- You’re sending the events that you chose in the strategy. You can see the events received during the last 90 days in the Personalization section of the dashboard.
- You’ve included and weighted facets in your strategy. To select facets for the strategy, you need to first declare the attributes as facets.
- You’re sending events related to the facets you chose in the strategy.
- You’ve set a non-zero Personalization impact. You can set the Personalization impact at the application-level in your Personalization dashboard, or with the
personalizationImpactsearch parameter, at query time.
You’ve simulated your strategy for real users
- You’ve used the simulator in the dashboard’s Personalization section to simulate your strategy for various users and queries. The personalized results are as you would expect.
Enabling Personalization on searches
userToken in your search requests.
- You’ve set
trueeither as a search parameter or in the index configuration.
- You’re using consistent
userTokens in events and searches. To have personalized results, you must use the same
userTokenfor the events you send for a particular user and the searches that user makes.
If you haven’t sent events for a particular
userToken in the last 90 days, Algolia doesn’t personalize that user’s results.
Before enabling Personalization for all your users, it’s best to A/B test your Personalization implementation first.