@algolia/autocomplete-plugin-algolia-insights

What is @algolia/autocomplete-plugin-algolia-insights?

@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.

What are @algolia/autocomplete-plugin-algolia-insights's main functionalities?

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',
  },
});

Other packages similar to @algolia/autocomplete-plugin-algolia-insights

react-instantsearch

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

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.

README

@algolia/autocomplete-plugin-algolia-insights

The Algolia Insights plugin automatically sends click and conversion events to the Algolia Insights API whenever a user interacts with the autocomplete.

Installation

yarn add @algolia/autocomplete-plugin-algolia-insights
# or
npm install @algolia/autocomplete-plugin-algolia-insights

Documentation

See Documentation.