Reports top searches, no-result searches, click and conversion rates, revenue and other search analytics aggregated from query and Insights data. One of only six Algolia APIs that returns machine-readable x-ratelimit-* response headers.
This API exposes
30 operations
across 27 paths,
and defines 66 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against 2 base URLs: https://analytics.{region}.algolia.com, https://analytics.algolia.com.
30 operations27 paths66 schemas1 DELETE23 GET5 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://analytics.algolia.com
Authentication
API Key, API Key
Resource Areas
1
Authentication & Security 2
Algolia Analytics 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 30
Across 27 paths, the API surfaces 30 operations — 1 DELETE, 23 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
analytics 30
GET
/{path}
Send requests to the Algolia REST API
customGet2 params→ 200400402403404
POST
/{path}
Send requests to the Algolia REST API
customPost2 paramsbody→ 200400402403404
PUT
/{path}
Send requests to the Algolia REST API
customPut2 paramsbody→ 200400402403404
DELETE
/{path}
Send requests to the Algolia REST API
customDelete2 params→ 200400402403404
GET
/2/searches
Retrieve top searches
getTopSearches10 params→ 200400402403404
GET
/2/searches/count
Retrieve number of searches
getSearchesCount4 params→ 200400402403404
GET
/2/searches/noResults
Retrieve the most frequent searches without results
The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are TablePayload (8 properties), TimeseriesPayload (7 properties), CatalogEntry (4 properties), getTopFilterForAttribute (4 properties). Each schema is shown below with its type and property counts.
topSearchesResponseWithRevenueAnalytics
object
1 property1 required
DomainCatalog
object
4 properties4 required
FilterDefinition
object
4 properties1 required
operator
string
Character that characterizes how the filter is applied. For example, for a facet filter facet:value, : is the operator. For a numeric filter count50, is the op…
topSearchesResponse
object
1 property1 required
search
string
Search query.
noClickCount
integer
Number of times this search was returned as a result without any click.
ScalarResponse
object
Object keyed by metric kind, each mapping to its aggregate value.
direction
string
withFilterCount
integer
Number of searches for this term with applied filters.
noResultCount
integer
Number of searches without any results.
addToCartCount
integer
Number of add-to-cart events from this search.
clickPositions
array
List of positions in the search results and clicks associated with this search.
getTopFilterForAttributeResponse
object
1 property1 required
ErrorBase
object
Error.
1 property
getTopFilterAttributesResponse
object
1 property1 required
getTopSearchesResponse
topHitsResponseWithAnalytics
object
1 property1 required
getTopHitsResponse
ParameterReference
object
2 properties1 required
noClickRate
number
No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
parameterValue
Literal value. Its JSON type depends on kind (array of strings for indices, string for dates, tags, and country, number for numeric operands, and so on).
orderDirection
string
Sort direction.
filterOperator
string
Comparison operator applied to a filter field, one of: =, !=, , =, <=, IN, TAGTREE, CONTAINS, STARTSWITH, CONTAINSPREFIX. Requires a parameter to carry the ope…
CatalogEntry
object
4 properties4 required
purchaseRate
averageClickPosition
trackedSearchCount
integer
Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.
conversionCount
integer
Number of conversions from this search.
noResultsRate
number
No results rate: calculated as the number of searches with zero results divided by the total number of searches.
getTopFiltersNoResultsValues
object
2 properties2 required
parameters_count
integer
Number of occurrences.
hit
string
Object ID of a record returned as a search result.
DistributionDefinition
object
4 properties2 required
currencies
object
Revenue associated with this search: broken down by currency.
TableResponse
object
1 property1 required
FieldReference
object
2 properties1 required
updatedAtNullable
DistributionPayload
object
4 properties2 required
getTopFilterAttribute
object
2 properties2 required
clickCount
integer
Number of clicks associated with this search.
clickThroughRate
orderBy
string
Attribute by which to order the response items. If the clickAnalytics parameter is false, only searchCount is available.
getTopFiltersNoResultsResponse
object
1 property1 required
count
integer
Number of searches.
binEdge
A histogram bin edge. Use integers for discrete distributions and floating-point values for continuous ones.
addToCartRate
Catalog
object
1 property1 required
TablePayload
object
When groupBy is set, orderBy is required.
8 properties2 required
date
string
Date in the format YYYY-MM-DD.
DistributionResponse
object
Object keyed by histogram , each mapping a bin label to a count.
purchaseCount
integer
Number of purchase events from this search.
nbHits
integer
Number of results (hits).
OrderDefinition
object
3 properties2 required
getTopFilterForAttribute
object
4 properties4 required
TimeseriesResponse
object
1 property1 required
topHitsResponse
object
1 property1 required
getTopFiltersNoResultsValue
object
3 properties3 required
ParameterDefinition
object
3 properties2 required
topSearchesResponseWithAnalytics
object
1 property1 required
value
string
Attribute value.
TimeseriesPayload
object
7 properties2 required
attribute
string
Attribute name.
topHitsResponseWithRevenueAnalytics
object
1 property1 required
conversionRate
ScalarPayload
object
4 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Analytics 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.
