Insights

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.
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 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 user token from the Insights API Client state.

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

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.6.0/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
npm install search-insights

Initialize the Insights client

Starting from v2.4.0, you no longer need to initialize the Insights client and instead can pass credentials via headers per individual call. If you’re using the client with InstantSearch or Autocomplete, credentials are inferred from the passed search 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
4
5
6
7
8
<?php
require_once __DIR__."/vendor/autoload.php";
use Algolia\AlgoliaSearch\InsightsClient;

$insightsClient = InsightsClient::create(
  "YourApplicationID",
  "YourSearchOnlyAPIKey"
)

1
2
3
4
5
6
7
8
// If you include Insights in your HTML,
// comment out the following line
const aa = require("search-insights")

aa('init', {
  appId: 'YourApplicationID',
  apiKey: 'YourSearchOnlyAPIKey'
})

1
2
3
4
5
6
7
8
9
import com.algolia.search.client.ClientInsights
import com.algolia.search.model.APIKey
import com.algolia.search.model.ApplicationID

suspend fun main() {
  val client = ClientInsights(
    applicationID = ApplicationID("YourApplicationID"),
    apiKey = APIKey("YourSearchOnlyAPIKey")
}

1
2
3
4
5
6
7
8
9
10
11
12
using Algolia.Search.Clients;

class Program
{
  public static void Main(string[] args)
  {
    var client = new InsightsClient(
        "YourApplicationID",
        "YourSearchOnlyAPIKey"
    );
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
package events;

import com.algolia.search.DefaultInsightsClient;
import com.algolia.search.InsightsClient;

public class App {
  public static void main(String[] args) {
    InsightsClient client = DefaultInsightsClient.create(
          "YourApplicationID",
          "YourSearchOnlyAPIKey"
    );
  }
}

1
2
3
4
5
6
7
8
9
package main
import "github.com/algolia/algoliasearch-client-go/v3/algolia/insights"

func main() {
  insightsClient := insights.NewClient(
    "YourApplicationID",
    "YourSearchOnlyAPIKey"
  )
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
package org.example

import algolia.AlgoliaClient
import algolia.AlgoliaDsl._
import algolia.inputs.InsightsEvent

import scala.concurrent.ExecutionContext.Implicits.global

object Program extends App {
  val client = new AlgoliaClient(
    "YourApplicationID",
    "YourSearchOnlyAPIKey"
  )
}

Identify users

You need to provide anonymous or pseudonymous user identifiers as userToken when tracking Insights events. To identify users consistently, you should provide your own user IDs:

Copy
// See previous code snippet for how to initialize the Insights client
aa('setUserToken', 'user-token-1');

The search-insights library can also generate anonymous user IDs and store them in a cookie which persists across sessions.

Copy
const aa = require('search-insights')

aa('init', {
  appId: 'YourApplicationID',
  apiKey: 'YourSearchOnlyAPIKey',
+ useCookie: true,
})

Ensure you obtain user consent before storing cookies on their device.

Concepts Understand the userToken

Did you find this page helpful?