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

1
2
3
4
5
<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch</artifactId>
  <version>4.7.0</version>
</dependency>

or to your build.gradle file for Gradle:

1
implementation 'com.algolia:algoliasearch:4.7.0'

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

1
2
import com.algolia.api.InsightsClient;
import com.algolia.model.insights.*;

To create an instance of the client:

1
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.

List of methods

Each method makes one request to the Insights API.

Events

User tokens

Did you find this page helpful?
Java API clients v4