Skip to main content
For more information, see Search analytics.

​
Base URLs

The base URLs for requests to the Analytics API are:
  • https://analytics.us.algolia.com
  • https://analytics.de.algolia.com
  • https://analytics.algolia.com (routes requests to the closest of the preceding servers, based on your geographical location)
Use the URL that matches your analytics region. All requests must use HTTPS.

​
Availability and authentication

Access to the Analytics API is available as part of the Premium or Elevate plans. To authenticate your API requests, add these headers:
  • x-algolia-application-id. Your Algolia application ID.
  • x-algolia-api-key. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint’s reference.
You can find your application ID and API key in the Algolia dashboard.

​
Rate limits

You can make up to 100 requests per minute per app to the Analytics API. Each response includes headers with information about your current limit:
  • x-ratelimit-limit. The number of requests allowed every 60 seconds.
  • x-ratelimit-remaining. The number of requests remaining in the current period.
  • x-ratelimit-reset. Timestamp in seconds since the Unix epoch when the rate limit resets.

​
Parameters

Query parameters must be URL-encoded. Non-ASCII characters must be UTF-8 encoded. Plus characters (+) are interpreted as spaces.

​
Response status and errors

The Analytics API returns JSON responses. Since JSON doesn’t guarantee any specific ordering, don’t rely on the order of attributes in the API response.
  • Successful responses return a 2xx status.
  • Client errors return a 4xx status.
  • Server errors return a 5xx status.
  • Error responses have a message property with more information.

​
Version

The current version of the Analytics API is version 2, as indicated by the /2/ in each endpoint’s URL.

​
Query aggregation

Algolia processes a new query with each keystroke. To avoid skewed analytics, it aggregates these inputs and only retains the user’s final query for reporting purposes. For more information, see Query aggregation.