Plan your implementation
On this page
When you build your search and browse interface, you should implement sending events at the same time. This lets you validate your user events before going live and collect enough events to make an impact sooner.
When planning which events to send, consider all interaction points your users have with your site:
- Category pages
- Search results pages
- Autocomplete menu
- Emails, newsletters, push notifications, and other pages
Must-have events for ecommerce
Every ecommerce search and browse implementation should send click events when users click products after performing a search. They should also include conversion events when users add products to the shopping cart.
Must-have events for product listing pages
| Event | Description |
|---|---|
PLP: Product Clicked |
A user clicked on a search result. Send a click event to capture the search query, which item was clicked, and the position in the search results. API method: clickedObjectIDsAfterSearchProperties: eventName, indexName, objectIDs, positions, userToken |
PLP: Product Added to Cart |
A user clicked on a search result. Send a click event to capture the search query, which item was clicked, and the position in the search results. API method: convertedObjectIDsAfterSearchProperties: eventName, indexName, objectIDs, userToken |
Must-have events for product detail pages
| Event | Description |
|---|---|
PDP: Product Added to Cart |
A user added an item to the cart on the product-detail page after performing a search. API method: convertedObjectIDsAfterSearchProperties: eventName, indexName, objectIDs, queryID, userToken |
PDP: Product Added to Cart |
A user added an item to the cart. API method: convertedObjectIDsProperties: eventName, indexName, objectIDs, userToken |
Must-have events for autocomplete
If you include products in the autocomplete menu of your search interface, you should send events for the user interactions with the autocomplete menu.
| Event | Description |
|---|---|
Autocomplete: Product Clicked |
A user clicked on a search result in the autocomplete menu. API method: clickedObjectIDsAfterSearchProperties: eventName, indexName, objectIDs, positions, userToken |
Autocomplete: Product Added to Cart |
A user added an item to the cart from the autocomplete menu. API method: convertedObjectIDsAfterSearchProperties: eventName, indexName, objectIDs, userToken |
Additional events for Personalization
You can add these events if you want to enhance your Personalization strategy.
| Event | Description |
|---|---|
PLP: Filter Clicked |
A user selected a facet value. API method: clickedFiltersProperties: eventName, indexName, filters, userToken |
PLP: Filter Viewed |
A user viewed a landing page. API method: viewedFiltersProperties: eventName, indexName, filters, userToken |
Product Viewed |
A user viewed a product page from an email, newsletter, push notification, or any other page. API method: viewedObjectIDsProperties: eventName, indexName, objectIDs, userToken |
Events for Algolia Recommend
See Event requirements for Algolia Recommend for more information.
Example events for media
When planning events to send for a media use case, consider the following example events.
View events
Article Viewed: a user viewed an article page.
Click events
Article Clicked: a user clicked on an article.Ad Clicked: a user clicked on an ad.
Conversion events
Article Read: a user reached the bottom of an article page.Article Bookmarked: a user bookmarked an article.Article Liked: a user liked an article.Article Recommended: a user recommended an article.Video Watched: a user watched a video.Playlist Followed: a user followed a playlist.Author Followed: a user followed an author.Brand Followed: a user followed a brand.
