Send events with InstantSearch.js
On this page
If you’re using InstantSearch and want to send Insights events, it’s best to do so directly from your InstantSearch.js implementation.
The InstantSearch Insights library allows developers to send click, conversion, and view events. For search-related events, it correlates the event with the queryIDs generated when you’ve set the clickAnalytics parameter to true.
Algolia uses valid search-related events for Click and Conversion Analytics. Click and Conversion Analytics form the foundation for more advanced features like A/B Testing and Dynamic Re-Ranking. Algolia uses all valid events for Personalization. Even if you aren’t planning on implementing Personalization right away, it’s helpful to consider sending events as if you were. This lets you implement Personalization later on with a robust corpus of well-formatted user data.
Requirements
search-insightsv1.6.2 or later.- InstantSearch.js v4.8.3 or later.
Installing the search-insights library
To send events in InstantSearch, you must first add the search-insights library to your application.
You can load the search-insights library with either the jsDelivr CDN or your static file server. If you choose the latter, you must update the ALGOLIA_INSIGHTS_SRC variable to point to the file URL on your file server.
Load the library by adding this snippet in the <head> of your HTML file.
1
2
3
4
5
6
7
8
<script>
var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@2.2.3/dist/search-insights.min.js";
!function(e,a,t,n,s,i,c){e.AlgoliaAnalyticsObject=s,e[s]=e[s]||function(){
(e[s].queue=e[s].queue||[]).push(arguments)},i=a.createElement(t),c=a.getElementsByTagName(t)[0],
i.async=1,i.src=n,c.parentNode.insertBefore(i,c)
}(window,document,"script",ALGOLIA_INSIGHTS_SRC,"aa");
</script>
jsDelivr is a third-party CDN. Algolia can’t provide support for such third-party services.
Using insights with Node.js
$
$
$
npm install search-insights
# or
yarn add search-insights
1
2
3
const aa = require('search-insights');
// or
import aa from 'search-insights';
Creating the insights middleware
All examples in this guide assume you’ve included InstantSearch.js in your web page from a CDN. If you’re using it with a package manager, you should adjust the way you import InstantSearch.js and its widgets. Read How to install InstantSearch.js for more information.
1
2
3
const insightsMiddleware = instantsearch.middlewares.createInsightsMiddleware({
insightsClient: window.aa,
})
Connecting InstantSearch with the insights middleware
1
2
3
4
5
6
const search = instantsearch({
searchClient,
indexName: 'INDEX_NAME',
})
search.use(insightsMiddleware)
Retrieving the queryID from the search response
When sending a search-related event to Algolia, you need to include the queryID of the most recent search. By default, the search response doesn’t contain a queryID. To retrieve it, you need to set the clickAnalytics parameter to true.
The insights middleware handles this for you.
Setting the userToken
By default, the search-insights library sets an anonymous token and stores it in a cookie. It’s best to set the userToken yourself using an internal user identifier. This lets you reliably identify users.
If you use search-insights >= 2.0.0, it doesn’t set an anonymous token automatically and no longer uses cookies by default.
If you want to enable it, refer to insightsInitParams.
1
aa('setUserToken', yourUserToken)
If you don’t already have that information, you can set it up later from your code. As soon as you’ve set it, the insights middleware ensures that every subsequent search includes a userToken.
Sending default events
When using any of the following connectors, the insights middleware automatically sends default events for some user behaviors like selecting a facet or viewing a result.
Sending events from refinement widgets
connectHierarchicalMenu:hierarchicalMenuconnectMenu:menuandmenuSelectconnectNumericMenu:numericMenuconnectRange:rangeInputandrangeSliderconnectRatingMenu:ratingMenuconnectRefinementList:refinementListconnectToggleRefinement:toggleRefinement
If you customize a widget using connectors, the insights middleware also sends events. You can turn off this behavior or change the default payload.
Sending events from results widgets
When using any of the following connectors, the insights middleware automatically sends default view events when hits are rendered.
connectAutocomplete:autocompleteconnectGeoSearch:geoSearchconnectHits:hitsconnectInfiniteHits:infiniteHits
If you customize a widget using connectors, the insights middleware also sends events. You can turn off this behavior or change the default payload.
The hits and infiniteHits widgets also expose a sendEvent function to the template, so that you can hook user behavior to custom click or conversion events at the template level.
Sending events
Usually, you want to send events when the user interacts with search results. This means you want to send the events from either the hits or the infiniteHits widget.
This example sets up the hits widget:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
search.addWidget(
instantsearch.widgets.hits({
container: '#hits',
templates: {
item(hit, { html, components }) {
return html`
<article>
<h3> ${components.Highlight({ attribute: 'name', hit })} </h3>
</article>
`
},
},
})
)
Sending the event
The item template exposes a sendEvent function. You can use it to send events when the user interacts with the hits.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<button
type="button"
onClick=${() => sendEvent('click', hit, 'Product Added')}
>
Add to cart
<!-- this button will send a click event when user clicks -->
</button>
<button
type="button"
onClick=${() => sendEvent('conversion', hit, 'Product Ordered')}
>
Order
<!-- this button will send a conversion event when user clicks -->
</button>
Once you’ve registered your index with the application ID and the API key, you can start sending events. For examples of the different kinds of events and what user behaviors translate into them, refer to the guide on capturing user behaviors as events.
Insights events (view, click, and conversion) don’t take immediate effect. There’s a delay of from a few minutes up to an hour (depending on whether they’re sent after a search or not and how long after a search they’re sent).
For a better estimation, see how long it takes for Insights events to be taken into account.
Based on the event type you send, you need different data. For example, a conversion event doesn’t need the positions attribute, but the click event does. This is because positions determines the average click position. The integration with InstantSearch handles all this for you. InstantSearch injects:
- All the necessary data based on the event to send
- The context of the current query.
If you intend to send these events with the Personalization feature, deciding which events to send and when to send them is vital. Read the guide on capturing user actions as events if you’re unsure about what to send.
Tracking queryID on other pages
Conversion events don’t always happen on a search results page. For example, a user could buy an item from a product detail page, meaning you must pass the queryID to that page.
Putting everything together
Here’s a full code snippet for sending click and conversion events from within a hits widget.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
search.addWidget(
instantsearch.widgets.hits({
container: '#hits',
templates: {
item(hit, { html, components, sendEvent }) {
return html`
<article>
<h3>
${components.Highlight({ attribute: 'name', hit })}
</h3>
<button
type="button"
onClick=${() => sendEvent('click', hit, 'Product Added')}
>
Add to cart
</button>
<button
type="button"
onClick=${() => sendEvent('conversion', hit, 'Product Ordered')}
>
Order
</button>
<article>
`
},
},
})
)
Advanced insights middle customizations
The insights middleware lets you turn off default events, change the default event payloads, send events from your custom widgets, and send events to third-party trackers. Check the insights middleware documentation to learn how to do this.
