API clients / Java

A/B testing API client (v3)

The A/B testing API client is part of the algoliasearch package. You can add this package to your pom.xml file for Maven:

Copy 
1
2
3
4
5

<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch</artifactId>
  <version>4.23.0</version>
</dependency>

or to your build.gradle file for Gradle:

Copy 
1

implementation 'com.algolia:algoliasearch:4.23.0'

To use the A/B testing client, add these imports to your files:

Copy 
1
2

import com.algolia.api.AbtestingV3Client;
import com.algolia.config.*;

To create an instance of the client:

Copy 
1

AbtestingV3Client client = new AbtestingV3Client("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.

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?
Java API clients v4