How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Algolia

Algolia Insights API

Inbound event-ingestion API for click, conversion, view and purchase signals that feed Personalization, Recommend, A/B Testing and Analytics. Accepts events; does not emit them, which is why Algolia publishes no AsyncAPI or webhook contract.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 7 operations across 4 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://insights.{region}.algolia.io, https://insights.algolia.io.

7 operations 4 paths 41 schemas 2 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://insights.algolia.io
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Algolia Insights API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-algolia-application-id (appId). An API key is passed in the header as x-algolia-api-key (apiKey). By default, every request must be authenticated.

  • appId — Your Algolia application ID.
  • apiKey — Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions.…

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

insights 7
GET
/{path}
Send requests to the Algolia REST API
customGet 2 params → 200400402403404
POST
/{path}
Send requests to the Algolia REST API
customPost 2 params body → 200400402403404
PUT
/{path}
Send requests to the Algolia REST API
customPut 2 params body → 200400402403404
DELETE
/{path}
Send requests to the Algolia REST API
customDelete 2 params → 200400402403404
POST
/1/events
Send events
pushEvents body → 200400401404405413422
DELETE
/1/usertokens/{userToken}
Delete user token events
deleteUserToken 1 param → 204422429
GET
/setClientApiKey
Switch the API key used to authenticate requests
setClientApiKey 1 param → 204

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are AddedToCartObjectIDsAfterSearch (12 properties), PurchasedObjectIDsAfterSearch (11 properties), AddedToCartObjectIDs (11 properties), PurchasedObjectIDs (11 properties). Each schema is shown below with its type and property counts.

filters
array
Applied facet filters. Facet filters are facet:value pairs. Facet values must be URL-encoded, such as, discount:10%25.
EventsItems
objectDataAfterSearch
object
4 properties
currency
string
Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
objectDataList
array
Extra information about the records involved in a purchase or add-to-cart event. If specified, it must have the same length as objectIDs.
InstantsearchEvent
string
ConvertedFilters
object
7 properties 5 required
objectData
object
3 properties
Instantsearch
object
6 properties 3 required
ClickEvent
string
ConvertedObjectIDs
object
Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages…
7 properties 5 required
userToken
string
Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.alg…
ConvertedObjectIDsAfterSearch
object
Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product de…
8 properties 6 required
discount
Absolute value of the discount for this product, in units of currency.
ViewEvent
string
AddedToCartObjectIDsAfterSearch
object
Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're building your category pages with Algolia, you'…
12 properties 7 required
objectDataAfterSearchList
array
Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as objectIDs.
ViewedFilters
object
Use this method to capture active filters. For example, when browsing a category page, users see content filtered on that specific category.
7 properties 5 required
quantity
integer
Quantity of a product that has been purchased or added to the cart. The total purchase value is the sum of quantity multiplied with the price for each purchase…
PurchasedObjectIDs
object
Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages,…
11 properties 6 required
timestamp
integer
Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was…
value
Total monetary value of this event in units of currency. This should be equal to the sum of price times quantity.
agentID
string
Unique identifier for an agent session. Used to correlate instantsearch events with a specific agent interaction.
ViewedObjectIDs
object
Use this event to track when users viewed items in the search results.
7 properties 5 required
index
string
Index name (case-sensitive) to which the event's items belong.
EventsResponse
object
The response of the Insights API.
2 properties
PurchasedObjectIDsAfterSearch
object
Use this event to track when users make a purchase after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this…
11 properties 7 required
objectIDs
array
Object IDs of the records that are part of the event.
authenticatedUserToken
string
Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as authenticatedUserToken. This lets you kee…
queryID
string
Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add clickAnalytics: true as a search req…
eventName
string
Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/colle…
ClickedObjectIDs
object
Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use…
7 properties 5 required
positions
array
Position of the clicked item the search results. You must provide 1 position for each objectID.
AddedToCartObjectIDs
object
Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build you…
11 properties 6 required
AddToCartEvent
string
price
Final price of a single product, including any discounts, in units of currency.
ClickedObjectIDsAfterSearch
object
Click event after an Algolia request. Use this event to track when users click items in the search results. If you're building your category pages with Algolia…
9 properties 7 required
ConversionEvent
string
ClickedFilters
object
Use this event to track when users click facet filters in your user interface.
7 properties 5 required
ErrorBase
object
Error.
1 property
PurchaseEvent
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

algolia-insights-api-openapi.yml Raw ↑
#Analytics#Event#REST
← Back to A APIs
API Details
ID
algolia:algolia-insights-api
Base URL
https://insights.algolia.io
Docs
https://www.algolia.com/doc/rest-api/insights/
Provider
Algolia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=algolia-algolia-insights-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/algolia-algolia-insights-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Algolia Insights API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.