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

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

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

1
2
import algoliasearch.api.InsightsClient
import algoliasearch.config.*

To create an instance of the client:

1
2
3
4
5
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.

List of methods

Each method makes one request to the Insights API.

Events

User tokens

Did you find this page helpful?
Scala API clients v2