Capture a variant's settings and stop the A/B test
Captures the settings of the given variant and of the control, then stops the A/B test.
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, editSettingsAuthorizations
Your Algolia application ID.
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
Unique A/B test identifier.
224
One-based index of the A/B test variant. The control is variant 1.
x >= 12
Body
Options for capturing a variant's settings.
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