Aug 08, 2025
A/B testing API client (v3)
The A/B testing API client is part of the algoliasearch-scala package.
You can add this package to your build.gradle.kts file:
Copy
1
2
3
implementation("com.algolia:algoliasearch-client-kotlin:3.26.0")
// You also need to add a KTOR engine as dependency, for example:
implementation("io.ktor:ktor-client-java:$ktor_version")
To use the A/B testing client, add this import to your files:
Copy
1
2
3
import com.algolia.client.api.AbtestingV3Client
import com.algolia.client.configuration.*
import com.algolia.client.transport.*
To create an instance of the client:
Copy
1
val client = AbtestingV3Client(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY", region = "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.
A/B testing
| client.listABTests | List all A/B tests |
| client.addABTests | Create an A/B test |
| client.getABTest | Retrieve A/B test details |
| client.deleteABTest | Delete an A/B test |
| client.stopABTest | Stop an A/B test |
| client.scheduleABTest | Schedule an A/B test |
| client.estimateABTest | Estimate the sample size and duration of an A/B test |
| client.getTimeseries | Retrieve timeseries of an A/B test |
Did you find this page helpful?
