@algolia/autocomplete-plugin-algolia-insights
Advanced tools
A plugin to add Algolia Insights to Algolia Autocomplete.
@algolia/autocomplete-plugin-algolia-insights is a plugin for Algolia's Autocomplete library that integrates Algolia Insights, allowing you to track user interactions and improve search relevance based on user behavior.
Initialize the plugin
This code initializes the Algolia Insights plugin by passing the Algolia Analytics (aa) client to it. This setup is necessary to start tracking user interactions.
const algoliaInsightsPlugin = createAlgoliaInsightsPlugin({
insightsClient: window.aa,
});Track search results click
This code tracks when a user clicks on a search result. It sends the event name, index name, object IDs, positions, and query ID to Algolia Insights.
algoliaInsightsPlugin.onClick({
insightsMethod: 'clickedObjectIDsAfterSearch',
payload: {
eventName: 'Product Clicked',
index: 'your_index_name',
objectIDs: ['objectID1'],
positions: [1],
queryID: 'queryID',
},
});Track search results conversion
This code tracks when a user converts (e.g., makes a purchase) after searching. It sends the event name, index name, object IDs, and query ID to Algolia Insights.
algoliaInsightsPlugin.onConversion({
insightsMethod: 'convertedObjectIDsAfterSearch',
payload: {
eventName: 'Product Purchased',
index: 'your_index_name',
objectIDs: ['objectID1'],
queryID: 'queryID',
},
});react-instantsearch is a library for building search interfaces with Algolia in React. It includes connectors and widgets for tracking user interactions, but it is more focused on building complete search UIs rather than just tracking events.
search-insights is another library for sending events to Algolia Insights. It is similar to @algolia/insights but is designed to work with the InstantSearch.js library. It does not provide the same level of integration with the Autocomplete library.
The Algolia Insights plugin automatically sends click and conversion events to the Algolia Insights API whenever a user interacts with the autocomplete.
yarn add @algolia/autocomplete-plugin-algolia-insights
# or
npm install @algolia/autocomplete-plugin-algolia-insights
See Documentation.
1.9.0 (2023-04-24)
insights option to enable the Insights plugin (#1121) (c9d06fd)search-insights@2.6.0 (#1109) (63dd995)FAQs
A plugin to add Algolia Insights to Algolia Autocomplete.
The npm package @algolia/autocomplete-plugin-algolia-insights receives a total of 242,176 weekly downloads. As such, @algolia/autocomplete-plugin-algolia-insights popularity was classified as popular.
We found that @algolia/autocomplete-plugin-algolia-insights demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 82 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.