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 algoliasearch-scala package.
You can add this package to your build.sbt file:
1
2
3
4
// For Scala 3:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_3" % "2.25.0"
// For Scala 2:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_2" % "2.25.0"
To use the A/B testingV2 client, add these imports to your files:
1
2
import algoliasearch.api.AbtestingClient
import algoliasearch.config.*
To create an instance of the client:
1
2
3
4
5
val client = AbtestingClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = Option("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.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 |