Retrieve number of users

Retrieves the number of unique users within a time range, including a daily breakdown.

Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number.

By default, Algolia distinguishes search users by their IP address, unless you include a pseudonymous user identifier in your search requests with the userToken API parameter or x-algolia-usertoken request header. By default, the analyzed period includes the last eight days including the current day.

Usage

1
2
3
4
5
6
7
8
9
10
11
import algoliasearch.api.AnalyticsClient

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

val response = client.getUsersCount(
  index = "index"
)