> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Insights API client

> Collect events related to your search and discovery experience.

<Tabs>
  <Tab title="C#">
    The Insights API client is part of the `Algolia.Search` package.
    To install this package, run:

    ```sh Command line icon=square-terminal theme={"system"}
    dotnet add package Algolia.Search
    ```

    To use the Insights client, import these namespaces:

    ```cs C# icon=code theme={"system"}
    using Algolia.Search.Clients;
    using Algolia.Search.Http;
    using Algolia.Search.Models.Insights;
    ```

    To create an instance of the client:

    ```cs C# icon=code theme={"system"}
    var client = new InsightsClient(
      new InsightsConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
    );
    ```
  </Tab>

  <Tab title="Dart">
    The Insights API client is part of the `algoliasearch` package.
    To install this package, run:

    ```sh Command line icon=square-terminal theme={"system"}
    dart pub add algoliasearch
    ```

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

    ```dart Dart icon=code theme={"system"}
    import 'package:algolia_client_insights/algolia_client_insights.dart';
    ```

    To create an instance of the client:

    ```dart Dart icon=code theme={"system"}
    final client = InsightsClient(
        appId: 'ALGOLIA_APPLICATION_ID',
        apiKey: 'ALGOLIA_API_KEY',
        region: 'ALGOLIA_APPLICATION_REGION');
    ```
  </Tab>

  <Tab title="Go">
    The Insights API client is part of the `algoliasearch-client-go` package.
    To install it, run:

    ```sh Command line icon=square-terminal theme={"system"}
    go get github.com/algolia/algoliasearch-client-go
    ```

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

    ```go Go icon=code theme={"system"}
    import "github.com/algolia/algoliasearch-client-go/v4/algolia/insights"
    ```

    To create an instance of the client:

    ```go Go icon=code theme={"system"}
    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**](https://dashboard.algolia.com/account/infrastructure/analytics) section of the Algolia dashboard.
  </Tab>

  <Tab title="Java">
    The Insights API client is part of the `algoliasearch` package.
    You can add this package to your `pom.xml` file for **Maven**:

    ```xml pom.xml icon=code-xml theme={"system"}
    <dependency>
      <groupId>com.algolia</groupId>
      <artifactId>algoliasearch</artifactId>
      <version>4.25.0</version>
    </dependency>
    ```

    or to your `build.gradle` file for **Gradle**:

    ```groovy build.gradle icon=braces theme={"system"}
    implementation 'com.algolia:algoliasearch:4.25.0'
    ```

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

    ```java Java icon=code theme={"system"}
    import com.algolia.api.InsightsClient;
    import com.algolia.config.*;
    ```

    To create an instance of the client:

    ```java Java icon=code theme={"system"}
    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**](https://dashboard.algolia.com/account/infrastructure/analytics) section of the Algolia dashboard.
  </Tab>

  <Tab title="JavaScript">
    The Insights API client is part of the `@algolia/client-insights` package.
    To install this package, run:

    ```sh Command line icon=square-terminal theme={"system"}
    npm install @algolia/client-insights
    ```

    To use this client, run:

    ```js JavaScript icon=code theme={"system"}
    import { insightsClient } from "@algolia/client-insights";

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

    <Note>
      To send events from your front- or backend,
      consider using the [`search-insights`](/doc/libraries/search-insights) library instead.
      It comes with many helper methods for sending specific event types
      and managing the user token.
    </Note>
  </Tab>

  <Tab title="Kotlin">
    The Insights API client is part of the `algoliasearch-scala` package.
    You can add this package to your `build.gradle.kts` file:

    ```kt build.gradle.kts icon=braces theme={"system"}
    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:

    ```kt Kotlin icon=code theme={"system"}
    import com.algolia.client.api.InsightsClient
    import com.algolia.client.configuration.*
    import com.algolia.client.transport.*
    ```

    To create an instance of the client:

    ```kt Kotlin icon=code theme={"system"}
    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**](https://dashboard.algolia.com/account/infrastructure/analytics) section of the Algolia dashboard.
  </Tab>

  <Tab title="PHP">
    The Insights API client is part of the `algoliasearch-client-php` package.
    To install this package, run:

    ```sh Command line icon=square-terminal theme={"system"}
    composer require algolia/algoliasearch-client-php
    ```

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

    ```php PHP icon=code theme={"system"}
    use Algolia\AlgoliaSearch\Api\InsightsClient;
    ```

    To create an instance of the client:

    ```php PHP icon=code theme={"system"}
    $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**](https://dashboard.algolia.com/account/infrastructure/analytics) section of the Algolia dashboard.
  </Tab>

  <Tab title="Python">
    The Insights API client is part of the `algoliasearch` package.
    You can install this package with `pip`:

    ```sh Command line icon=square-terminal theme={"system"}
    pip install 'algoliasearch>=4,<5'
    ```

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

    ```python Python icon=code theme={"system"}
    from algoliasearch.insights.client import InsightsClientSync
    from json import loads
    ```

    To create an instance of the client:

    ```python Python icon=code theme={"system"}
    # 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**](https://dashboard.algolia.com/account/infrastructure/analytics) section of the Algolia dashboard.

    ## Async code

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

    ```python Python icon=code theme={"system"}
    import asyncio
    from algoliasearch.insights.client import InsightsClient
    ```

    The client supports the [`async with`](https://peps.python.org/pep-0492/#asynchronous-context-managers-and-async-with) statement to automatically close open connections.

    ```python Python icon=code theme={"system"}
    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.
  </Tab>

  <Tab title="Ruby">
    The Insights API client is part of the `algolia` gem.
    To install this gem, run:

    ```sh Command line icon=square-terminal theme={"system"}
    gem install algolia
    ```

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

    ```ruby Ruby icon=code theme={"system"}
    require "algolia"
    ```

    To create an instance of the client:

    ```ruby Ruby icon=code theme={"system"}
    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**](https://dashboard.algolia.com/account/infrastructure/analytics) section of the Algolia dashboard.
  </Tab>

  <Tab title="Scala">
    The Insights API client is part of the `algoliasearch-scala` package.
    You can add this package to your `build.sbt` file:

    ```txt build.sbt icon=braces theme={"system"}
    // 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 Scala icon=code theme={"system"}
    import algoliasearch.api.InsightsClient
    import algoliasearch.config.*
    ```

    To create an instance of the client:

    ```scala Scala icon=code theme={"system"}
    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**](https://dashboard.algolia.com/account/infrastructure/analytics) section of the Algolia dashboard.
  </Tab>

  <Tab title="Swift">
    The Insights API client is part of the `algoliasearch-client-swift` package.
    You can add this package to your `Package.swift` file:

    ```swift Package.swift icon=braces theme={"system"}
    // 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 Swift icon=code theme={"system"}
    import Insights
    ```

    To create an instance of the client:

    ```swift Swift icon=code theme={"system"}
    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**](https://dashboard.algolia.com/account/infrastructure/analytics) section of the Algolia dashboard.
  </Tab>
</Tabs>

## 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**](https://dashboard.algolia.com/account/infrastructure/analytics) section of the Algolia dashboard.