Documentation Index
Fetch the complete documentation index at: https://algolia.com/llms.txt
Use this file to discover all available pages before exploring further.
Base URLs
Base URLs for the Analytics API:https://analytics.us.algolia.comhttps://analytics.de.algolia.comhttps://analytics.algolia.com(alias ofanalytics.us.algolia.com)
Availability and authentication
Access to the Analytics API is available as part of the Premium or Elevate plans. Add these headers to authenticate requests: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.
Rate limits
You can make up to 100 requests per minute per app to the Analytics API. The response includes headers with information about the limits.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
2xxstatus - Client errors return a
4xxstatus - Server errors are indicated by a
5xxstatus.
message property with more information.
Version
The current version of the Analytics API is version 2, indicated by the/2/ in each endpoint’s URL.