Estimate the sample size and duration of an A/B test

Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.

Usage

Required ACL: analytics
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
from algoliasearch.abtesting.client import AbtestingClientSync
from json import loads

# 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"
)

response = client.estimate_ab_test(
    estimate_ab_test_request={
        "configuration": {
            "emptySearch": {
                "exclude": True,
            },
            "minimumDetectableEffect": {
                "size": 0.03,
                "metric": "conversionRate",
            },
        },
        "variants": [
            {
                "index": "AB_TEST_1",
                "trafficPercentage": 50,
            },
            {
                "index": "AB_TEST_2",
                "trafficPercentage": 50,
            },
        ],
    },
)
Did you find this page helpful?