Skip to main content
POST
curl
The captured settings can later be applied to the control index with the applyVariantSettings operation, and read back with the getABTestSettings operation. The A/B test must have reached 80% of its planned duration. Earlier requests return 400. Settings can only be captured once per A/B test. A second request returns 409. synonyms and enableRules are not captured, so applying the captured settings never changes them on the control index. Required ACL: analytics, editSettings

Authorizations

x-algolia-application-id
string
header
required

Your Algolia application ID.

x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

id
integer
required

Unique A/B test identifier.

Example:

224

variantId
integer
required

One-based index of the A/B test variant. The control is variant 1.

Required range: x >= 1
Example:

2

Body

application/json

Options for capturing a variant's settings.

saveFeaturesSettings
boolean
default:false

Whether to also capture the variant's index settings and feature-specific settings. This must be true for A/B tests whose variants use different indices so that the captured variant settings can later be applied.

Response

OK

Last modified on October 12, 2026