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
require "algolia"

client = Algolia::AnalyticsClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")

response = client.get_users_count("index")
Did you find this page helpful?