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 A/B Testing API

Creates and manages A/B tests across index configurations and relevance settings, scoring variants on click-through and conversion. Two live versions: v3 is current, and the entire v2 surface is marked deprecated in Algolia's own contract.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 12 operations across 7 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

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

12 operations 7 paths 42 schemas 2 DELETE5 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Base URL
https://analytics.algolia.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Algolia A/B Testing 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 12

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

abtesting-v3 12
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
/3/abtests
Create an A/B test
addABTests body → 200400402403404
GET
/3/abtests
List all A/B tests
listABTests 5 params → 200400402403404
GET
/3/abtests/{id}
Retrieve A/B test details
getABTest 1 param → 200400402403404
DELETE
/3/abtests/{id}
Delete an A/B test
deleteABTest 1 param → 200400402403404
POST
/3/abtests/{id}/stop
Stop an A/B test
stopABTest 1 param → 200400402403404
POST
/3/abtests/estimate
Estimate the sample size and duration of an A/B test
estimateABTest body → 200400402403404
GET
/3/abtests/{id}/timeseries
Retrieve timeseries of an A/B test
getTimeseries 4 params → 200400402403404422
GET
/setClientApiKey
Switch the API key used to authenticate requests
setClientApiKey 1 param → 204

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are metricResult (10 properties), ABTest (10 properties), variant (7 properties), MetricsFilter (4 properties). Each schema is shown below with its type and property counts.

ABTests
timeseriesVariant
object
1 property
metricDate
object
2 properties
MetricsFilter
object
Boolean filter applied to the A/B test population. Each filter targets a boolean metric and decides whether to include (true) or exclude (false) matching recor…
4 properties 2 required
variants
array
A/B test variants. The first variant is your control index, typically your production index. All of the additional variants are indexes with changed settings t…
createdAt
string
Date and time when the A/B test was created, in RFC 3339 format.
Decision
object
Outcome of the A/B test once a winner has been declared. Only present when a winning variant has been declared, so its presence indicates the test has been dec…
2 properties 2 required
ABTest
object
10 properties 7 required
metricDates
array
MetricsFilters
array
List of metric filters applied to the test population.
ABTestConfiguration
object
A/B test configuration.
3 properties
metricResult
object
10 properties 4 required
timeseriesVariants
array
A/B test timeseries variants. The first variant is your control index, typically your production index. All of the additional variants are indexes with changed…
MinimumDetectableEffect
object
Configuration for the smallest difference between test variants you want to detect.
2 properties 2 required
createMetric
object
Defines a metric to be retrieved during an A/B test.
2 properties 1 required
trafficPercentage
integer
Percentage of search requests each variant receives.
EffectMetric
string
Metric for which you want to detect the smallest relative difference.
metrics
array
All ABTest metrics that were defined during test creation.
AddABTestsVariant
MetricName
string
variant
object
7 properties 4 required
variantMetadata
object
Variant specific metadata.
1 property
stoppedAt
stringnull
Date and time when the A/B test was stopped, in RFC 3339 format.
updatedAt
string
Date and time when the A/B test was last updated, in RFC 3339 format.
metricMetadata
object
Metric specific metadata.
2 properties
Timeseries
object
2 properties 2 required
ABTestResponse
object
3 properties 3 required
direction
string
Sort order for A/B tests by start date. Use 'asc' for ascending or 'desc' for descending. Active A/B tests are always listed first.
abTestsVariantSearchParams
index
string
Index name of the A/B test variant (case-sensitive).
filterEffects
object
A/B test filter effects resulting from configuration settings.
2 properties
Status
string
A/B test status. - active. The A/B test is live and search traffic is split between the two variants. - stopped. You stopped the A/B test. The A/B test data is…
ErrorCorrectionType
string
Multiple-testing correction method applied when evaluating metric significance.
customSearchParams
object
Search parameters to add to the test variant. Only use this parameter if the two variants use the same index.
1 property 1 required
description
string
Description for this variant.
endAt
string
End date and time of the A/B test, in RFC 3339 format.
abTestsVariant
object
3 properties 2 required
abTestID
integer
Unique A/B test identifier.
taskID
integer
Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress…
EstimateABTestResponse
object
2 properties
ErrorBase
object
Error.
1 property
name
string
A/B test name.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

algolia-abtesting-v3-api-openapi.yml Raw ↑
#Experimentation#REST
← Back to A APIs
API Details
ID
algolia:algolia-a-b-testing-api
Base URL
https://analytics.algolia.com
Docs
https://www.algolia.com/doc/rest-api/abtesting/
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-a-b-testing-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/algolia-algolia-a-b-testing-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 A/B Testing 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.