Aug 11, 2025
A/B testing API client (v2)
An updated version of the A/B testing API (v3) is available. For differences, compatibility, and migration guidance, see A/B testing API v2 vs v3.
The A/B testingV2 API client is part of the algolia gem.
To install this gem, run:
Copy
1
gem install algolia
To use the A/B testingV2 client, add this import to your files:
Copy
1
require "algolia"
To create an instance of the client:
Copy
1
client = Algolia::AbtestingClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
Replace ALGOLIA_APPLICATION_ID_REGION with your Algolia application’s analytics region: us for the United States or de for Europe.
You can check your analytics region in the Infrastructure > Analytics section of the Algolia dashboard.
List of methods
Each method makes one request to the A/B testing API v2.
A/B testing
| client.list_ab_tests | List all A/B tests |
| client.add_ab_tests | Create an A/B test |
| client.get_ab_test | Retrieve A/B test details |
| client.delete_ab_test | Delete an A/B test |
| client.stop_ab_test | Stop an A/B test |
| client.schedule_ab_test | Schedule an A/B test |
| client.estimate_ab_test | Estimate the sample size and duration of an A/B test |
Did you find this page helpful?
