Retrieve number of users

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

Since it 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.
  • The analyzed period includes the last eight days including the current day.

Usage

Required ACL: analytics
1
2
3
4
5
6
7
8
9
import com.algolia.client.api.AnalyticsClient
import com.algolia.client.configuration.*
import com.algolia.client.transport.*

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

var response = client.getUsersCount(
  index = "index",
)
Did you find this page helpful?