Analytics API client

Collect events related to your search and discovery experience.

C#

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

dotnet add package Algolia.Search

To use the Analytics client, import these namespaces:

C#

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

To create an instance of the client:

C#

var client = new AnalyticsClient(
  new AnalyticsConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);

Replace ALGOLIA_APPLICATION_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.

Go

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

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

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

Go

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

To create an instance of the client:

Go

client, err := analytics.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", analytics.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: analytics.US for the United States or analytics.DE for Europe. You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.

Java

The Analytics 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 Analytics client, add these imports to your files:

Java

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

To create an instance of the client:

Java

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

Replace ALGOLIA_APPLICATION_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 analytics API client is part of the algoliasearch package. To install this package, run:

npm install algoliasearch

To use the analytics client:

JavaScript

import { algoliasearch } from "algoliasearch";

const client = algoliasearch("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");
const analyticsClient = client.initAnalytics({ region: "ALGOLIA_APPLICATION_REGION" });

Replace ALGOLIA_APPLICATION_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.

The algoliasearch package includes API clients for the Search, Recommend, Analytics, A/B testing, and Personalization API. If you just want to use the analytics API client, you can install its package on its own:

npm install @algolia/client-analytics

To use it, run:

JavaScript

import { analyticsClient } from "@algolia/client-analytics";

const client = analyticsClient(
  "ALGOLIA_APPLICATION_ID",
  "ALGOLIA_API_KEY",
  "ALGOLIA_APPLICATION_REGION"
);

Kotlin

The Analytics 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 Analytics client, add this import to your files:

Kotlin

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

To create an instance of the client:

Kotlin

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

Replace ALGOLIA_APPLICATION_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 Analytics API client is part of the algoliasearch-client-php package. To install this package, run:

composer require algolia/algoliasearch-client-php

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

PHP

use Algolia\AlgoliaSearch\Api\AnalyticsClient;

To create an instance of the client:

PHP

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

Replace ALGOLIA_APPLICATION_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 Analytics API client is part of the algoliasearch package. You can install this package with pip:

pip install 'algoliasearch>=4,<5'

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

Python

from algoliasearch.analytics.client import AnalyticsClientSync
from json import loads

To create an instance of the client:

Python

# In an asynchronous context, you can use AnalyticsClient instead, which exposes the exact same methods.
client = AnalyticsClientSync(
    "ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
)

Replace ALGOLIA_APPLICATION_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 Analytics client in async environments, add these imports instead:

Python

import asyncio
from algoliasearch.analytics.client import AnalyticsClient

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

Python

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

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

Ruby

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

gem install algolia

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

Ruby

require "algolia"

To create an instance of the client:

Ruby

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

Replace ALGOLIA_APPLICATION_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 Analytics 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 Analytics client, add these imports to your files:

Scala

import algoliasearch.api.AnalyticsClient
import algoliasearch.config.*

To create an instance of the client:

Scala

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

Replace ALGOLIA_APPLICATION_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 Analytics 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: "Analytics", package: "algoliasearch-client-swift")
      ]
    )
  ]
)

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

Swift

import Analytics

To create an instance of the client:

Swift

let client = try AnalyticsClient(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 Analytics 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.