List all A/B tests

Lists all A/B tests you configured for this application.

GET /3/abtests

curl

cURL

curl --request GET \
  --url 'https://analytics.us.algolia.com/3/abtests?offset=0&limit=10&indexPrefix=dev_&indexSuffix=_development&direction=desc' \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "abtests": [
    {
      "abTestID": 224,
      "updatedAt": "2023-06-15T15:06:44.400601Z",
      "createdAt": "2023-06-15T15:06:04.249906Z",
      "endAt": "2023-06-17T00:00:00Z",
      "name": "Custom ranking sales rank test",
      "status": "active",
      "variants": [
        {
          "description": "Current production index",
          "index": "delcourt_production",
          "trafficPercentage": 60,
          "metrics": [
            [
              {
                "name": "addToCartCount",
                "updatedAt": "2025-06-15T15:06:44.400601Z",
                "value": 5,
                "pValue": 0.01
              },
              {
                "name": "clickThroughRate",
                "updatedAt": "2025-05-15T17:52:15.644906Z",
                "value": 0.20869847452125934,
                "pValue": 0.004
              },
              {
                "name": "revenue",
                "dimension": "USD",
                "updatedAt": "2025-05-15T17:52:15.644906Z",
                "value": 1200.5,
                "pValue": 0.04,
                "metadata": {
                  "winsorizedValue": 80.2
                }
              },
              {
                "name": "revenue",
                "dimension": "EUR",
                "updatedAt": "2025-05-15T17:52:15.644906Z",
                "value": 999.66,
                "pValue": 0.04,
                "metadata": {
                  "winsorizedValue": 888.8
                }
              }
            ]
          ],
          "estimatedSampleSize": 0,
          "metadata": {
            "filterEffects": {
              "outliers": {
                "usersCount": 1,
                "trackedSearchesCount": 237
              },
              "emptySearch": {
                "usersCount": 1,
                "trackedSearchesCount": 237
              }
            }
          },
          "customSearchParameters": {
            "enablePersonalization": true,
            "personalizationImpact": 50
          }
        }
      ],
      "stoppedAt": "2023-06-15T15:06:44.400601Z",
      "configuration": {
        "minimumDetectableEffect": {
          "size": 0.5,
          "metric": "addToCartRate"
        },
        "filters": [
          {
            "domain": "abtesting",
            "name": "isOutlier",
            "trackEffects": true,
            "includes": true
          }
        ],
        "errorCorrection": "bonferroni"
      },
      "migratedAbTestID": 224
    }
  ],
  "count": 10,
  "total": 12
}

Required ACL: analytics

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

offset · integer · default: 0

Position of the first item to return.

Required range: x >= 0

limit · integer · default: 10

Number of items to return.

indexPrefix · string

Index name prefix. Only A/B tests for indices starting with this string are included in the response.

indexSuffix · string

Index name suffix. Only A/B tests for indices ending with this string are included in the response.

direction · enum<string>

Sort order for A/B tests by start date. Use 'asc' for ascending or 'desc' for descending. Active A/B tests are always listed first.

Sort order for A/B tests by start date. Use 'asc' for ascending or 'desc' for descending. Active A/B tests are always listed first.

Available options: asc, desc

Example:

"desc"

Response

200

application/json

OK

abtests · object[] | null · required

A/B tests.

Show child attributes

abtests. abTestID · integer · required

Unique A/B test identifier.

Example:

224

abtests. updatedAt · string · required

Date and time when the A/B test was last updated, in RFC 3339 format.

Example:

"2023-06-15T15:06:44.400601Z"

abtests. createdAt · string · required

Date and time when the A/B test was created, in RFC 3339 format.

Example:

"2023-06-15T15:06:04.249906Z"

abtests. endAt · string · required

End date and time of the A/B test, in RFC 3339 format.

Example:

"2023-06-17T00:00:00Z"

abtests. name · string · required

A/B test name.

Example:

"Custom ranking sales rank test"

abtests. status · enum<string> · required

A/B test status.

• active. The A/B test is live and search traffic is split between the two variants.
• stopped. You stopped the A/B test. The A/B test data is still available for analysis.
• expired. The A/B test was automatically stopped after reaching its end date.
• failed. Creating the A/B test failed.

Available options: active, stopped, expired, failed

Example:

"active"

abtests. variants · object[] · required

A/B test variants.

The first variant is your control index, typically your production index. All of the additional variants are indexes with changed settings that you want to test against the control.

Show child attributes

abtests.variants. description · string · required

Description for this variant.

Example:

"Current production index"

abtests.variants. index · string · required

Index name of the A/B test variant (case-sensitive).

Example:

"delcourt_production"

abtests.variants. trafficPercentage · integer · required

Percentage of search requests each variant receives.

Required range: 1 <= x <= 99

Example:

60

abtests.variants. metrics · object[] · required

All ABTest metrics that were defined during test creation.

Show child attributes

abtests.variants.metrics. name · string · required

abtests.variants.metrics. updatedAt · string · required

Date and time when the metric was last updated, in RFC 3339 format.

abtests.variants.metrics. value · number<double> · required

abtests.variants.metrics. pValue · number<double> · required

PValue for the first variant (control) will always be 0. For the other variants, pValue is calculated for the current variant based on the control.

abtests.variants.metrics. valueCIHigh · number<double>

The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).

abtests.variants.metrics. valueCILow · number<double>

The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).

abtests.variants.metrics. dimension · string

Dimension defined during test creation.

abtests.variants.metrics. metadata · object

Metric specific metadata.

Show child attributes

abtests.variants.metrics.metadata. winsorizedValue · number<double>

Only present in case the metric is 'revenue'. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).

abtests.variants.metrics.metadata. mean · number<double>

Mean value for this metric.

Example:

53.7

Example:

{ "winsorizedValue": 888.8, "mean": 53.7 }

abtests.variants.metrics. criticalValue · number<double>

The value that was computed during error correction. It is used to determine significance of the metric pValue. The critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given configuration during the A/B test creation.

abtests.variants.metrics. significant · boolean

Whether the pValue is significant or not based on the critical value and the error correction algorithm used.

abtests.variants. estimatedSampleSize · integer

Estimated number of searches required to achieve the desired statistical significance.

The A/B test configuration must include a minimumDetectableEffect setting for this number to be included in the response.

Example:

0

abtests.variants. metadata · object

Variant specific metadata.

Show child attributes

abtests.variants.metadata. filterEffects · object

A/B test filter effects resulting from configuration settings.

Show child attributes

abtests.variants.metadata.filterEffects. outliers · outliersFilter · object

Outliers removed from the A/B test as a result of configuration settings.

Show child attributes

abtests.variants.metadata.filterEffects.outliers. usersCount · integer

Number of users removed from the A/B test.

Example:

1

abtests.variants.metadata.filterEffects.outliers. trackedSearchesCount · integer

Number of tracked searches removed from the A/B test.

Example:

237

Example:

{
  "usersCount": 1,
  "trackedSearchesCount": 237
}

abtests.variants.metadata.filterEffects. emptySearch · emptySearchFilter · object

Empty searches removed from the A/B test as a result of configuration settings.

Show child attributes

abtests.variants.metadata.filterEffects.emptySearch. usersCount · integer

Number of users removed from the A/B test.

Example:

1

abtests.variants.metadata.filterEffects.emptySearch. trackedSearchesCount · integer

Number of tracked searches removed from the A/B test.

Example:

237

Example:

{
  "usersCount": 1,
  "trackedSearchesCount": 237
}

abtests.variants. customSearchParameters · object

Search parameters applied to this variant when the same index is used for multiple variants. Only present if custom search parameters were provided during test creation.

Example:

{
  "enablePersonalization": true,
  "personalizationImpact": 50
}

abtests. stoppedAt · string | null

Date and time when the A/B test was stopped, in RFC 3339 format.

Example:

"2023-06-15T15:06:44.400601Z"

abtests. configuration · configuration · object

A/B test configuration.

Show child attributes

abtests.configuration. minimumDetectableEffect · object

Configuration for the smallest difference between test variants you want to detect.

Show child attributes

abtests.configuration.minimumDetectableEffect. size · number<double> · required

Smallest difference in an observable metric between variants. For example, to detect a 10% difference between variants, set this value to 0.1.

Required range: 0 <= x <= 1

abtests.configuration.minimumDetectableEffect. metric · enum<string> · required

Metric for which you want to detect the smallest relative difference.

Available options: addToCartRate, clickThroughRate, conversionRate, purchaseRate, noResultsRate

abtests.configuration. filters · object[]

List of metric filters applied to the test population.

Show child attributes

abtests.configuration.filters. domain · string · required

Metric domain (for example abtesting, personalization).

Example:

"abtesting"

abtests.configuration.filters. name · string · required

Public metric name.

Example:

"isOutlier"

abtests.configuration.filters. trackEffects · boolean

Whether the experiment should record the effects of this filter.

abtests.configuration.filters. includes · boolean

If true, keep items that match the filter; if false, exclude them.

abtests.configuration. errorCorrection · enum<string>

Multiple-testing correction method applied when evaluating metric significance.

Available options: bonferroni, benjamini-hochberg

abtests. migratedAbTestID · integer

Unique migrated A/B test identifier.

Example:

224

count · integer · required

Number of A/B tests.

Example:

10

total · integer · required

Number of retrievable A/B tests.

Example:

12