Search Insights

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

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.

Search Insights

Table of Contents