Algolia Insights API

Name: Insights API
Brand: Insights API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentAnalyticsProduct AnalyticsapiKey7 EndpointsREST

Install Jentic One Beta

Connect the Insights API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Insights API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Insights API.

Send click, conversion, and view events tied to a user token via POST /1/events

Batch up to 1000 events per request to feed Algolia's behavioral relevance models

Delete all events for a specific user token to comply with GDPR right-to-erasure requests via DELETE /1/usertokens/{userToken}

GET STARTED

Start building with Insights API

Explore with Jentic

View OpenAPI Document

For Agents

Send click, conversion, and view events to Algolia so Recommend, Personalization, and Dynamic Re-Ranking can learn from user behavior. Also handles user-token deletion for GDPR.

Use for: I need to record a click event when a user selects a search result, Send a conversion event tied to a query ID, Delete all events for a user who requested data erasure, Track an add-to-cart event with item value and currency

Not supported: Does not handle search execution, indexing, or recommendation generation - use the Algolia Search and Recommend APIs for those. Use this API for behavioral event capture only.

Use Cases

Patterns agents use Insights API for, with concrete tasks.

★ Click and conversion tracking for search relevance

Send clickedObjectIDsAfterSearch and convertedObjectIDsAfterSearch events from your storefront UI to Algolia. Each event carries the queryID returned by the original search, so Algolia can attribute clicks and conversions to specific queries and feed Dynamic Re-Ranking. Without these events, click and conversion analytics in the Algolia dashboard remain empty.

POST a clickedObjectIDsAfterSearch event to /1/events with userToken 'user_42', queryID from the search, indexName 'products', objectIDs ['sku_123'] and positions [1]

GDPR data erasure for user tokens

When a user invokes their right to be forgotten, call DELETE /1/usertokens/{userToken} to remove all events associated with that token from Algolia's analytics and recommendation models. The endpoint returns rate-limit headers so you can pace bulk deletions during compliance sweeps.

Call DELETE /1/usertokens/user_42 to wipe all event history for that user token

Revenue and add-to-cart attribution

Send addedToCartObjectIDsAfterSearch and purchasedObjectIDsAfterSearch events with value, currency, and quantity fields. Algolia ties each event to the originating queryID and attributes revenue to specific searches, giving merchandisers a clear view of which queries drive sales.

POST a purchasedObjectIDsAfterSearch event with objectIDs ['sku_a','sku_b'], objectData containing price 49.99 USD per item, and the queryID from the originating search

Agent-driven event capture in conversational UIs

An AI agent recommending products through a chat surface can fire view, click, and conversion events as the user interacts with the suggestions. Through Jentic, the agent finds the pushEvents operation by intent, loads the schema, and executes - no manual integration with the Insights endpoint needed.

Search Jentic for 'send Algolia conversion event', load pushEvents, and execute with the user's queryID and the sku they selected

Key Endpoints

7 endpoints — jentic publishes the only available openapi specification for the algolia insights api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/1/events

Send a batch of analytics events

DELETE

/1/usertokens/{userToken}

Delete all events for a user token

GET

/setClientApiKey

Retrieve a temporary client API key

POST

/1/events

Send a batch of analytics events

DELETE

/1/usertokens/{userToken}

Delete all events for a user token

GET

/setClientApiKey

Retrieve a temporary client API key

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Algolia API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'record a click event' or 'send a conversion event', and Jentic returns the matching Algolia Insights operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Insights API through Jentic.

Why is there no official OpenAPI spec for the Insights API?

Algolia does not publish a standalone OpenAPI specification for the Insights API. Jentic generates and maintains this spec so that AI agents and developers can call the Insights API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the Algolia Insights API use?

Two API key headers: x-algolia-application-id and x-algolia-api-key with the search ACL. Through Jentic, both are stored in the vault and injected at request time, so agents never see the raw key.

Can I track purchases with the Insights API?

Yes. Send a purchasedObjectIDsAfterSearch event to /1/events with objectIDs, objectData (price and quantity), currency, and the originating queryID. Algolia ties the revenue back to the search that produced the click.

What are the rate limits for the Algolia Insights API?

The spec does not declare numeric rate limits, but each /1/events request can carry up to 1000 events as a single batch. Use batching to stay under throughput limits and watch for 429 responses with Retry-After headers.

How do I delete user data through Jentic?

Search Jentic for 'delete Algolia user token', load deleteUserToken, and execute with the userToken string. Jentic injects credentials and calls DELETE /1/usertokens/{userToken} - the response includes remaining rate-limit headers.

Does the Insights API validate the events I send?

It only checks that events are formatted correctly. It does not verify that indexName, objectIDs, or userToken correspond to real records in the Search API. Check the Events health page in the Algolia dashboard to confirm events are usable for Recommend and Dynamic Re-Ranking.

Can I limit what my agent is allowed to do with the Algolia Insights API?

Yes. Because you run Jentic One yourself, your own rules decide which Insights API operations and credentials the agent can use. You can grant it only the operations it needs, such as sending click, conversion, and view events to /1/events, while withholding others. Destructive operations like deleting a user token via DELETE /1/usertokens/{userToken} stay off unless you explicitly add them.