Library for reporting click, conversion and view metrics using the Algolia Insights API
npm install 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
- Releasing
- License
> NOTE: You're looking at the documentation of search-insights v2. (_Click here for v1.x documentation._)
v2 introduces a breaking change which is useCookie being false by default.
Since v2.0.4, search-insights no longer validates event payloads.
You can visit https://algolia.com/events/debugger instead.
---
> 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][insights-api].
>
> - Google Tag Manager
> - Segment
For information on how to set up search-insights.js in a browser environment, see our documentation on [Installing and Initializing the Insights Client][insights-js-docs].
We also have documentation for using search-insights.js with [InstantSearch][instantsearch] and [Autocomplete][autocomplete].
- For information on using search-insights.js with [InstantSearch][instantsearch], see our documentation on [Sending click and conversion events with InstantSearch.js][instantsearch-guide].
- For information on using search-insights.js with [Autocomplete][autocomplete], see our documentation on [Sending Algolia Insights events with Autocomplete][autocomplete-guide].
> NOTE: If you are using Require.js, see our Note for Require.js users.
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.
[insights-api]: https://www.algolia.com/doc/rest-api/insights/
[insights-js-docs]: https://www.algolia.com/doc/api-client/methods/insights/#install-the-insights-client
[instantsearch]: https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/
[instantsearch-guide]: https://www.algolia.com/doc/guides/building-search-ui/events/js/
[autocomplete]: https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/
[autocomplete-guide]: https://www.algolia.com/doc/ui-libraries/autocomplete/guides/sending-algolia-insights-events/
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.
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
For information on releasing, see RELEASE.md.
Search Insights is MIT licensed.