A/B testing API client
The A/B testing API client is part of the algoliasearch
package.
You can install this package with pip
:
1
pip install 'algoliasearch>=4,<5'
To use the A/B testing client, add this import to your files:
1
from algoliasearch.abtesting.client import AbtestingClientSync
To create an instance of the client:
1
2
3
4
# In an asynchronous context, you can use AbtestingClient instead, which exposes the exact same methods.
client = AbtestingClientSync(
"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.
Async code
To use the A/B testing client in async environments, add these imports instead:
1
2
import asyncio
from algoliasearch.abtesting.client import AbtestingClient
The client supports the async with
statement to automatically close open connections.
1
2
3
async def run():
async with AbtestingClient(ALGOLIA_APPLICATION_ID, ALGOLIA_API_KEY) as client:
# client.search(...)
The method names are the same for synchronous and asynchronous methods.
List of methods
Each method makes one request to the A/B testing API.
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 |