Insights API client

Collect events related to your search and discovery experience.

C#

The Insights API client is part of the Algolia.Search package. To install this package, run:

Command line

dotnet add package Algolia.Search

To use the Insights client, import these namespaces:

C#

using Algolia.Search.Clients;
using Algolia.Search.Http;
using Algolia.Search.Models.Insights;

To create an instance of the client:

C#

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

Dart

The Insights API client is part of the algoliasearch package. To install this package, run:

Command line

dart pub add algoliasearch

To use the Insights client, add this import to your files:

Dart

import 'package:algolia_client_insights/algolia_client_insights.dart';

To create an instance of the client:

Dart

final client = InsightsClient(
    appId: 'ALGOLIA_APPLICATION_ID',
    apiKey: 'ALGOLIA_API_KEY',
    region: 'ALGOLIA_APPLICATION_REGION');

Go

The Insights API client is part of the algoliasearch-client-go package. To install it, run:

Command line

go get github.com/algolia/algoliasearch-client-go

To use the Insights client, add this import to your files:

Go

import "github.com/algolia/algoliasearch-client-go/v4/algolia/insights"

To create an instance of the client:

Go

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)
}

Make sure to use the region that matches your Algolia application’s analytics region: insights.US for the United States or insights.DE for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

Java

The Insights API client is part of the algoliasearch package. You can add this package to your pom.xml file for Maven:

pom.xml

<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch</artifactId>
  <version>4.25.0</version>
</dependency>

or to your build.gradle file for Gradle:

build.gradle

implementation 'com.algolia:algoliasearch:4.25.0'

To use the Insights client, add these imports to your files:

Java

import com.algolia.api.InsightsClient;
import com.algolia.config.*;

To create an instance of the client:

Java

InsightsClient client = new InsightsClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");

Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or de for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

JavaScript

The Insights API client is part of the @algolia/client-insights package. To install this package, run:

Command line

npm install @algolia/client-insights

To use this client, run:

JavaScript

import { insightsClient } from "@algolia/client-insights";

const client = insightsClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");

To send events from your front- or backend, consider using the search-insights library instead. It comes with many helper methods for sending specific event types and managing the user token.

Kotlin

The Insights API client is part of the algoliasearch-scala package. You can add this package to your build.gradle.kts file:

build.gradle.kts

implementation("com.algolia:algoliasearch-client-kotlin:3.28.0")
// You also need to add a KTOR engine as dependency, for example:
implementation("io.ktor:ktor-client-java:$ktor_version")

To use the Insights client, add this import to your files:

Kotlin

import com.algolia.client.api.InsightsClient
import com.algolia.client.configuration.*
import com.algolia.client.transport.*

To create an instance of the client:

Kotlin

val client = InsightsClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY", region = "ALGOLIA_APPLICATION_REGION")

Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or de for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

PHP

The Insights API client is part of the algoliasearch-client-php package. To install this package, run:

Command line

composer require algolia/algoliasearch-client-php

To use the Insights client, add this import to your files:

PHP

use Algolia\AlgoliaSearch\Api\InsightsClient;

To create an instance of the client:

PHP

$client = InsightsClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');

Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or de for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

Python

The Insights API client is part of the algoliasearch package. You can install this package with pip:

Command line

pip install 'algoliasearch>=4,<5'

To use the Insights client, add this import to your files:

Python

from algoliasearch.insights.client import InsightsClientSync
from json import loads

To create an instance of the client:

Python

# 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"
)

Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or de for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

Async code

To use the Insights client in async environments, add these imports instead:

Python

import asyncio
from algoliasearch.insights.client import InsightsClient

The client supports the async with statement to automatically close open connections.

Python

async def run():
    async with InsightsClient(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) as client:
        # client.search(...)

The method names are the same for synchronous and asynchronous methods.

Ruby

The Insights API client is part of the algolia gem. To install this gem, run:

Command line

gem install algolia

To use the Insights client, add this import to your files:

Ruby

require "algolia"

To create an instance of the client:

Ruby

client = Algolia::InsightsClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")

Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or de for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

Scala

The Insights API client is part of the algoliasearch-scala package. You can add this package to your build.sbt file:

build.sbt

// For Scala 3:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_3" % "2.27.0"
// For Scala 2:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_2" % "2.27.0"

To use the Insights client, add these imports to your files:

Scala

import algoliasearch.api.InsightsClient
import algoliasearch.config.*

To create an instance of the client:

Scala

val client = InsightsClient(
  appId = "ALGOLIA_APPLICATION_ID",
  apiKey = "ALGOLIA_API_KEY",
  region = Option("ALGOLIA_APPLICATION_REGION")
)

Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or de for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

Swift

The Insights API client is part of the algoliasearch-client-swift package. You can add this package to your Package.swift file:

Package.swift

// swift-tools-version: 5.10
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
  name: "Algolia API clients",
  platforms: [
    .macOS(.v11)
  ],
  dependencies: [
    .package(
      url: "https://github.com/algolia/algoliasearch-client-swift.git", from: "9.28.0")
  ],
  targets: [
    .executableTarget(
      name: "Algolia API clients",
      dependencies: [
        .product(name: "Insights", package: "algoliasearch-client-swift")
      ]
    )
  ]
)

To use the Insights client, add this import to your files:

Swift

import Insights

To create an instance of the client:

Swift

let client = try InsightsClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us)

Make sure to use the region that matches your Algolia application’s analytics region: region.us for the United States and region.de for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

Analytics region

The Insights API client requires specifying your Algolia application’s analytics region to properly route requests to the correct data center.

Replace ALGOLIA_APPLICATION_REGION with your application’s analytics region:

• us for the United States
• de for Europe

You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.