Skip to main content
Events represent user interactions with your app or website. They unlock powerful features, such as recommendations, personalization, smarter search results, and analytics that help you optimize your user experience. For more information, see Get started with events.

​
Client libraries

Use Algolia’s API clients, libraries, and integrations to collect events from your UI and send them to the Insights API. See Algolia’s ecosystem.

​
Base URLs

The base URLs for making requests to the Insights API are:
  • https://insights.us.algolia.io
  • https://insights.de.algolia.io
  • https//insights.algolia.io (routes requests to the closest of the preceding servers, based on your geographical location)
All requests must use HTTPS.

​
Authentication

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.

​
Request format

Request bodies must be JSON objects.

​
Response status and errors

Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers.
  • 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.
The Insights API doesn’t verify whether event properties—such as indexName, objectIDs, or userToken— correspond to existing data in the Search API. It only checks that these properties are correctly formatted. To ensure your events are valid and can be used for features like Analytics or Dynamic Re-Ranking, review them in the Events health section of the dashboard.

​
Version

The current version of the Insights API is version 1, as indicated by the /1/ in each endpoint’s URL.
⌘I