search-insights

What is search-insights?

The search-insights npm package is a JavaScript library that allows you to send analytics events to Algolia's Insights API. It helps you track user interactions with your search and discovery experiences, such as clicks, conversions, and view events.

What are search-insights's main functionalities?

Sending Click Events

This feature allows you to send click events to Algolia's Insights API. You can track which products users are clicking on after performing a search.

const searchInsights = require('search-insights');

searchInsights('init', { apiKey: 'yourAPIKey', appId: 'yourAppId' });

searchInsights('clickedObjectIDsAfterSearch', {
  eventName: 'Product Clicked',
  index: 'yourIndexName',
  queryID: 'theQueryID',
  objectIDs: ['objectID1', 'objectID2'],
  positions: [1, 2]
});

Sending Conversion Events

This feature allows you to send conversion events to Algolia's Insights API. You can track which products users are purchasing after performing a search.

const searchInsights = require('search-insights');

searchInsights('init', { apiKey: 'yourAPIKey', appId: 'yourAppId' });

searchInsights('convertedObjectIDsAfterSearch', {
  eventName: 'Product Purchased',
  index: 'yourIndexName',
  queryID: 'theQueryID',
  objectIDs: ['objectID1', 'objectID2']
});

Sending View Events

This feature allows you to send view events to Algolia's Insights API. You can track which products users are viewing.

const searchInsights = require('search-insights');

searchInsights('init', { apiKey: 'yourAPIKey', appId: 'yourAppId' });

searchInsights('viewedObjectIDs', {
  eventName: 'Product Viewed',
  index: 'yourIndexName',
  objectIDs: ['objectID1', 'objectID2']
});

Other packages similar to search-insights

segment

Segment is a customer data platform that helps you collect, clean, and control your customer data. It provides a unified API to track user interactions and send them to various analytics services. Compared to search-insights, Segment offers a broader range of integrations and data management capabilities.

mixpanel

Mixpanel is an advanced analytics platform that helps you track user interactions with your web and mobile applications. It provides detailed insights into user behavior and allows you to create custom reports. Mixpanel is more focused on in-depth analytics and user behavior tracking compared to the more search-focused search-insights.

google-analytics

Google Analytics is a widely-used web analytics service that tracks and reports website traffic. It provides comprehensive insights into user behavior, traffic sources, and conversion rates. While Google Analytics offers a broader range of analytics features, search-insights is specifically tailored for tracking search-related events.

README

Search Insights

Search Insights lets you report click, conversion and view metrics using the Algolia Insights API.

Table of Contents

• Notices
  • Cookie usage
  • Payload validation
• Getting started
  • Browser
  • Node.js
• Documentation
• Contributing
• License

NOTE: You're looking at the documentation of search-insights v2. (Click here for v1.x documentation.)

Notices

Cookie usage

v2 introduces a breaking change which is useCookie being false by default. If it's false, search-insights doesn't generate anonymous userToken. It means no event will be sent until setUserToken is explicitly called.

Payload validation

Since v2.0.4, search-insights no longer validates event payloads. You can visit https://algolia.com/events/debugger instead.

---

Getting started

We have created dedicated integrations for Google Tag Manager and Segment. If you are using either of these platforms, it is recommended to use the dedicated integrations to manage sending events to the Insights API.

• Google Tag Manager
• Segment

Browser

For information on how to set up search-insights.js in a browser environment, see our documentation on Installing and Initializing the Insights Client.

We also have documentation for using search-insights.js with InstantSearch and Autocomplete.

• For information on using search-insights.js with InstantSearch, see our documentation on Sending click and conversion events with InstantSearch.js.
• For information on using search-insights.js with Autocomplete, see our documentation on Sending Algolia Insights events with Autocomplete.

NOTE: If you are using Require.js, see our Note for Require.js users.

Node.js

For information on how to set up search-insights.js in a Node.js environment, see our guide on Installing and Initializing the Insights Client for Node.js.

Documentation

Documentation for search-insights.js can be found in our main Algolia Docs website. For API Client reference information, see the Insights API Client Documentation.

Contributing

To run the examples and the code, you need to run two separate commands:

• yarn dev runs webpack and the Node.js server
• yarn build:dev runs Rollup in watch mode

To release, go on main (git checkout main) and use:

yarn run release

It will create a pull request for the next release. When it's reviewed, approved and merged, then CircleCI will automatically publish it to npm.

License

Search Insights is MIT licensed.

Changelog

2.9.0 (2023-10-13)

Features

• add support for authenticatedUserToken (#513) (0636a2d)