POST /2/abtests/estimate
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.
Servers
- https://analytics.{region}.algolia.com
- https://analytics.algolia.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
variants[] |
Array | Yes |
A/B test variants. |
configuration |
Object | Yes |
A/B test configuration for estimating the sample size and duration using minimum detectable effect. |
configuration.outliers |
Object | No |
Configuration for handling outliers. |
configuration.outliers.exclude |
Boolean | No |
Whether to exclude outliers when calculating A/B test results. Default value: true |
configuration.emptySearch |
Object | No |
Configuration for handling empty searches. |
configuration.emptySearch.exclude |
Boolean | No |
Whether to exclude empty searches when calculating A/B test results. |
configuration.minimumDetectableEffect |
Object | Yes |
Configuration for the smallest difference between test variants you want to detect. |
configuration.minimumDetectableEffect.metric |
String | Yes |
Metric for which you want to detect the smallest relative difference. Possible values:
|
configuration.minimumDetectableEffect.size |
Number | Yes |
Smallest difference in an observable metric between variants. For example, to detect a 10% difference between variants, set this value to 0.1. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.