queryID, and userToken work together,
see Click and conversion events.
To choose an implementation path,
see Choose how to send events.
Events by features
The following table lists events and where they’re used.| Search | Recommend | Advanced Personalization | Classic Personalization | |
|---|---|---|---|---|
clickedObjectIDsAfterSearch | ||||
convertedObjectIDsAfterSearch | ||||
addedToCartObjectIDsAfterSearch | ||||
purchasedObjectIDsAfterSearch | ||||
clickedObjectIDs | ||||
convertedObjectIDs | ||||
addedToCartObjectIDs | ||||
purchasedObjectIDs | ||||
viewedObjectIDs | ||||
clickedFilters | ||||
convertedFilters | ||||
viewedFilters |
The Search column refers to NeuralSearch, Dynamic Re-Ranking,
Query Categorization, Analytics, and A/B testing.
Minimum number of events
In general, the features that require events work better with more events. Some features need a minimum number of events to be active.Events requirements for NeuralSearch
- Minimum 1,000 click OR 100 conversion events within 30 days.
clickedObjectIDsAfterSearch(click)convertedObjectIDsAfterSearch(conversion)addedToCartObjectIDsAfterSearch(conversion)purchasedObjectIDsAfterSearch(conversion)
Events requirements for Recommend—Frequently Bought Together
- Minimum 1,000 conversion events with 2 or more products within 30 days
- Maximum 3,000,000 conversion events within 30 days
convertedObjectIDsAfterSearchconvertedObjectIDsaddedToCartObjectIDsAfterSearchaddedToCartObjectIDspurchasedObjectIDsAfterSearchpurchasedObjectIDs
Events requirements for Recommend Related Products
- Minimum 10,000 events within 30 days
- Maximum 3,000,000 events within 30 days
clickedObjectIDsAfterSearchclickedObjectIDsconvertedObjectIDsAfterSearchconvertedObjectIDsaddedToCartObjectIDsAfterSearchaddedToCartObjectIDspurchasedObjectIDsAfterSearchpurchasedObjectIDs
Events requirements for Recommend—Related Content
- Minimum 10 events on items with content-based attributes within 30 days
- Maximum 1,500,000 events within 30 days
Events requirements for Recommend—Trending Items and Trending Facet Values
- Minimum 500 conversion events within 30 days
- Maximum 3,000,000 conversion events.
convertedObjectIDsAfterSearchconvertedObjectIDsaddedToCartObjectIDsAfterSearchaddedToCartObjectIDspurchasedObjectIDsAfterSearchpurchasedObjectIDs
Events requirements for Dynamic Re-Ranking
- Minimum 20 click events OR 2 conversion events within 30 days
clickedObjectIDsAfterSearch(click)convertedObjectIDsAfterSearch(conversion)addedToCartObjectIDsAfterSearch(conversion)purchasedObjectIDsAfterSearch(conversion)
userToken) per search query per record (objectID).
Events requirements for Query Categorization
Query Categorization needs a minimum number of events to train the model for predicting categories. It always uses events from the last 90 days. Query Categorization uses these events:clickedObjectIDsAfterSearchconvertedObjectIDsAfterSearchaddedToCartObjectIDsAfterSearchpurchasedObjectIDsAfterSearch
Events requirements for Personalization
Classic Personalization and Advanced Personalization can use any of the above events. The requirements for Advanced Personalization are detailed in Requirements and limits.Events on category pages
You can build category pages with Algolia by sending an empty search query and an applied filter. Because category pages are just a different form of search requests, you’ll use the same events for category pages and search results. However, ensure you can differentiate between search and category page events by segmenting your analytics data. Use the events debugger and consistent event names to see which segment corresponds to which event.Events related and unrelated to Algolia requests
Some events come in two variants: with and without a query ID. Events with a query ID haveAfterSearch in their name.
Most Algolia features use events with query IDs, for example, to calculate the conversion rate of your search.
Events related to Algolia requests
Use methods withAfterSearch in their name when a click or conversion happens after an Algolia search or browse request.
These methods require a queryID, which Algolia returns when you set clickAnalytics to true.
Click and conversion events with a
queryID are time-sensitive.
They must occur within one hour of the corresponding search request.Events unrelated to Algolia requests
Use methods withoutAfterSearch when an interaction isn’t tied to a previous Algolia search or browse request.
Common examples include homepage modules, recommendation emails, and conversions that happen long after the original search.
For details on capturing, passing, and inferring queryID,
see Keep track of query IDs.