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.

GET /2/users/count

curl

cURL

curl --request GET \
  --url 'https://analytics.us.algolia.com/2/users/count?index=ALGOLIA_INDEX_NAME&startDate=2022-09-19&endDate=2023-01-21&tags=device%3Amobile%2520phone' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "count": 123,
  "dates": [
    {
      "date": "2023-06-14",
      "count": 123
    }
  ]
}

Required ACL: analytics

See also: Distinguish users for analytics

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

index · string · required

Index name.

Example:

"ALGOLIA_INDEX_NAME"

startDate · string

Start date of the period to analyze, in YYYY-MM-DD format.

Example:

"2022-09-19"

endDate · string

End date of the period to analyze, in YYYY-MM-DD format.

Example:

"2023-01-21"

tags · string

Tags by which to segment the analytics.

You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Segment your analytics data.

Response

200

application/json

OK

count · integer · required

Number of unique users.

dates · dailyUsers · object[] · required

Daily number of unique users.

Show child attributes

dates. date · string · required

Date in the format YYYY-MM-DD.

Example:

"2023-06-14"

dates. count · integer · required

Number of unique users.