Insights API client methods

This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

List of methods

Init init init init init init init init init init init	Initialize the Insights API client to communicate with the Algolia Insights API.
Clicked object IDs after search clickedObjectIDsAfterSearch clickedObjectIDsAfterSearch clickedObjectIDsAfterSearch clicked_object_ids_after_search clicked_object_ids_after_search ClickedObjectIDsAfterSearch clickedObjectIDsAfterSearch ClickedObjectIDsAfterSearch clickedAfterSearch send event ClickedObjectIDsAfterSearch	Send a click event related to an Algolia request.
Clicked object IDs clickedObjectIDs clickedObjectIDs clickedObjectIDs clicked_object_ids clicked_object_ids ClickedObjectIDs clickedObjectIDs ClickedObjectIDs clicked send event ClickedObjectIDs	Send a click event to capture clicked items.
Clicked filters clickedFilters clickedFilters clickedFilters clicked_filters clicked_filters ClickedFilters clickedFilters ClickedFilters clicked send event ClickedFilters	Send a click event to capture when users select filters.
Converted object IDs after search convertedObjectIDsAfterSearch convertedObjectIDsAfterSearch convertedObjectIDs converted_object_ids_after_search converted_object_ids_after_search ConvertedObjectIDsAfterSearch convertedObjectIDsAfterSearch ConvertedObjectIDsAfterSearch convertedAfterSearch send event ConvertedObjectIDsAfterSearch	Send a conversion event related to an Algolia request.
Converted object IDs convertedObjectIDs convertedObjectIDs convertedObjectIDs converted_object_ids converted_object_ids ConvertedObjectIDs convertedObjectIDs ConvertedObjectIDs converted send event ConvertedObjectIDs	Send a conversion event to capture clicked items.
Converted filters convertedFilters convertedFilters convertedFilters converted_filters converted_filters ConvertedFilters convertedFilters ConvertedFilters converted send event ConvertedFilters	Send a conversion event to capture the filters a user selected when converting.
Added to cart object IDs after search addedToCartObjectIDsAfterSearch addedToCartObjectIDsAfterSearch addedToCartObjectIDsAfterSearch added_to_cart_object_ids_after_search added_to_cart_object_ids_after_search AddedToCartObjectIDsAfterSearch addedToCartObjectIDsAfterSearch AddedToCartObjectIDsAfterSearch addedToCartAfterSearch send event AddedToCartObjectIDsAfterSearch	Send a conversion event related to an Algolia request to capture when users add items to their shopping cart.
Added to cart object IDs addedToCartObjectIDs addedToCartObjectIDs addedToCartObjectIDs added_to_cart_object_ids added_to_cart_object_ids AddedToCartObjectIDs addedToCartObjectIDs AddedToCartObjectIDs addedToCart send event AddedToCartObjectIDs	Send a conversion event to capture when users add items to their shopping cart.
Purchased object IDs after search purchasedObjectIDsAfterSearch purchasedObjectIDsAfterSearch purchasedObjectIDsAfterSearch purchased_object_ids_after_search purchased_object_ids_after_search PurchasedObjectIDsAfterSearch purchasedObjectIDsAfterSearch PurchasedObjectIDsAfterSearch purchasedAfterSearch send event PurchasedObjectIDsAfterSearch	Send a conversion event related to an Algolia request to capture when users purchase items.
Purchased object IDs purchasedObjectIDs purchasedObjectIDs purchasedObjectIDs purchased_object_ids purchased_object_ids PurchasedObjectIDs purchasedObjectIDs PurchasedObjectIDs purchased send event PurchasedObjectIDs	Send a conversion event to capture when users purchase items.
Viewed object IDs viewedObjectIDs viewedObjectIDs viewedObjectIDs viewed_object_ids viewed_object_ids ViewedObjectIDs viewedObjectIDs ViewedObjectIDs Viewed object IDs send event ViewedObjectIDs	Send a view event to capture viewed items.
Viewed filters viewedFilters viewedFilters viewedFilters viewed_filters viewed_filters ViewedFilters viewedFilters ViewedFilters viewed send event ViewedFilters	Send a view event to capture the active filters for items a user viewed.
Send events sendEvents sendEvents sendEvents send_events send_events SendEvents sendEvents SendEvents sendEvents send events	Send a list of events in a single request.
Set user token setUserToken setUserToken setUserToken setUserToken setUserToken setUserToken setUserToken setUserToken setUserToken setUserToken	Set the anonymous user token for all subsequent events sent to the Algolia Insights API.
Get user token getUserToken getUserToken getUserToken getUserToken getUserToken getUserToken getUserToken getUserToken getUserToken getUserToken	Get the anonymous user token from the Insights API Client state.
Set authenticated user token setAuthenticatedUserToken setAuthenticatedUserToken setAuthenticatedUserToken setAuthenticatedUserToken setAuthenticatedUserToken setAuthenticatedUserToken setAuthenticatedUserToken setAuthenticatedUserToken setAuthenticatedUserToken setAuthenticatedUserToken	Set the authenticated user token for all subsequent events sent to the Algolia Insights API.
Get authenticated user token getAuthenticatedUserToken getAuthenticatedUserToken getAuthenticatedUserToken getAuthenticatedUserToken getAuthenticatedUserToken getAuthenticatedUserToken getAuthenticatedUserToken getAuthenticatedUserToken getAuthenticatedUserToken getAuthenticatedUserToken	Get the authenticated user token from the Insights API Client state.
Add user agent addAlgoliaAgent addAlgoliaAgent addAlgoliaAgent addAlgoliaAgent addAlgoliaAgent addAlgoliaAgent addAlgoliaAgent addAlgoliaAgent addAlgoliaAgent addAlgoliaAgent	Add a custom user agent to the request.

The Algolia Insights API lets you collect events related to your search and discovery experience. Events are actions that users take on your app or website. They unlock powerful features, such as recommendations, personalization, smarter search results, and analytics that help you optimize your user experience.

Guides Get started with click and conversion events

Send click and conversion events with InstantSearch

Send click and conversion events with Autocomplete

API Insights API

Install the Insights client

The Insights client is a separate npm package. Find the source code on GitHub.

To send Insights events from your JavaScript app, either include a code snippet directly in your HTML or install it as a dependency in your project.

Include the Insights client in your HTML

Paste the following code snippet into the <head> tag of every page where you want to track Insights events.

Copy
<script>
  var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@2.17.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)},e[s].version=(n.match(/@([^\/]+)\/?/) || [])[1],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>

If you prefer hosting your own version, copy the script in your own project.

Copy
<script>
  var ALGOLIA_INSIGHTS_SRC = 'path/to/search-insights.min.js';

  // …
</script>

Install the Insights client with npm

Install the search-insights package in your project:

Copy

1
2
3
npm install search-insights
# or
yarn add search-insights

Initialize the Insights client

To initialize the Insights client, you need your Algolia application ID and your API key with search permissions. You can find both in your Algolia dashboard.

Copy

1
2
3
var client = new InsightsClient(
  new InsightsConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);

1
2
3
4
5
client, err := insights.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", insights.US)
if err != nil {
  // The client can fail to initialize if you pass an invalid parameter.
  panic(err)
}

1
2
3
4
# In an asynchronous context, you can use InsightsClient instead, which exposes the exact same methods.
client = InsightsClientSync(
    "ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
)

Find all the parameters you can use in the init method documentation.

Starting from v2.4.0, you can also pass credentials using headers for each call. If you’re using the client with InstantSearch or Autocomplete, credentials are inferred from the passed search client.

Identify users

It’s important to identify users so that you can give them a consistent experience, especially when using Personalization. Do this by providing an anonymous or pseudonymous user identifier (a userToken or authenticatedUserToken) when tracking Insights events.

Concepts Understand the user token

Did you find this page helpful?