List all A/B tests

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

GET /2/abtests

curl

cURL

curl --request GET \
  --url 'https://analytics.us.algolia.com/2/abtests?offset=0&limit=10&indexPrefix=dev_&indexSuffix=_development' \
  --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": [
        {
          "addToCartCount": 0,
          "clickCount": 65131,
          "conversionCount": 4785,
          "index": "delcourt_production",
          "noResultCount": 0,
          "purchaseCount": 0,
          "searchCount": 86269,
          "trafficPercentage": 60,
          "userCount": 55501,
          "trackedUserCount": 55501,
          "addToCartRate": 0,
          "averageClickPosition": 29.12342,
          "clickThroughRate": 0.22219857724813036,
          "conversionRate": 0.14546725846658964,
          "currencies": {
            "USD": {
              "currency": "USD",
              "revenue": 120,
              "mean": 53.7,
              "standardDeviation": 12.3,
              "winsorizedAmount": 23
            },
            "EUR": {
              "currency": "EUR",
              "revenue": 100,
              "mean": 43.7,
              "standardDeviation": 10.3,
              "winsorizedAmount": 10
            }
          },
          "description": "Current production index",
          "estimatedSampleSize": 0,
          "filterEffects": {
            "outliers": {
              "usersCount": 1,
              "trackedSearchesCount": 237
            },
            "emptySearch": {
              "usersCount": 1,
              "trackedSearchesCount": 237
            }
          },
          "purchaseRate": 0,
          "trackedSearchCount": 2
        }
      ],
      "clickSignificance": 1,
      "conversionSignificance": 1,
      "addToCartSignificance": 1,
      "purchaseSignificance": 1,
      "revenueSignificance": {
        "USD": 1,
        "EUR": 0.87
      },
      "stoppedAt": "2023-06-15T15:06:44.400601Z",
      "configuration": {
        "featureFilters": {
          "dynamicReRanking": true,
          "aiPerso": true,
          "multiSignalRanking": true
        },
        "outliers": {
          "exclude": true
        },
        "emptySearch": {
          "exclude": true
        },
        "minimumDetectableEffect": {
          "size": 0.5,
          "metric": "addToCartRate"
        }
      }
    }
  ],
  "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.

Response

200

application/json

OK

abtests · object[] | null · required

The list of A/B tests, null if no A/B tests are configured for this application.

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. The second variant is an index with changed settings that you want to test against the control.

Show child attributes

abtests.variants. addToCartCount · integer · required

Number of add-to-cart events for this variant.

Example:

0

abtests.variants. clickCount · integer · required

Number of click events for this variant.

Example:

65131

abtests.variants. conversionCount · integer · required

Number of click events for this variant.

Example:

4785

abtests.variants. index · string · required

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

Example:

"delcourt_production"

abtests.variants. noResultCount · integer | null · required

Number of searches without results for this variant.

Example:

0

abtests.variants. purchaseCount · integer · required

Number of purchase events for this variant.

Example:

0

abtests.variants. searchCount · integer | null · required

Number of searches for this variant.

Example:

86269

abtests.variants. trafficPercentage · integer · required

Percentage of search requests each variant receives.

Required range: 0 <= x <= 100

Example:

60

abtests.variants. userCount · integer | null · required

Number of users that made searches to this variant.

Example:

55501

abtests.variants. trackedUserCount · integer | null · required

Number of users that made tracked searches to this variant.

Example:

55501

abtests.variants. addToCartRate · number<double> | null

Add-to-cart rate for this variant.

Example:

0

abtests.variants. averageClickPosition · number<double> | null

Average click position for this variant.

Example:

29.12342

abtests.variants. clickThroughRate · number<double> | null

Click-through rate for this variant.

Example:

0.22219857724813036

abtests.variants. conversionRate · number<double> | null

Conversion rate for this variant.

Example:

0.14546725846658964

abtests.variants. currencies · object

A/B test currencies.

Show child attributes

abtests.variants.currencies. {key} · object

Show child attributes

abtests.variants.currencies.{key}. currency · string

Currency code.

Example:

"USD"

abtests.variants.currencies.{key}. revenue · number<double>

Revenue for this currency.

Example:

120

abtests.variants.currencies.{key}. mean · number<double>

Mean for this currency.

Example:

53.7

abtests.variants.currencies.{key}. standardDeviation · number<double>

Standard deviation for this currency.

Example:

12.3

abtests.variants.currencies.{key}. winsorizedAmount · number<double>

The amount of revenue for this currency that was removed after capping purchase amounts to the 95th percentile.

Example:

23

Example:

{
  "USD": {
    "currency": "USD",
    "revenue": 120,
    "mean": 53.7,
    "standardDeviation": 12.3,
    "winsorizedAmount": 23
  },
  "EUR": {
    "currency": "EUR",
    "revenue": 100,
    "mean": 43.7,
    "standardDeviation": 10.3,
    "winsorizedAmount": 10
  }
}

abtests.variants. description · string

Description for this variant.

Example:

"Current production index"

abtests.variants. estimatedSampleSize · integer

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

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

Example:

0

abtests.variants. filterEffects · object

A/B test filter effects resulting from configuration settings.

Show child attributes

abtests.variants.filterEffects. outliers · outliersFilter · object

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

Show child attributes

abtests.variants.filterEffects.outliers. usersCount · integer

Number of users removed from the A/B test.

Example:

1

abtests.variants.filterEffects.outliers. trackedSearchesCount · integer

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

Example:

237

Example:

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

abtests.variants.filterEffects. emptySearch · emptySearchFilter · object

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

Show child attributes

abtests.variants.filterEffects.emptySearch. usersCount · integer

Number of users removed from the A/B test.

Example:

1

abtests.variants.filterEffects.emptySearch. trackedSearchesCount · integer

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

Example:

237

Example:

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

abtests.variants. purchaseRate · number<double> | null

Purchase rate for this variant.

Example:

0

abtests.variants. trackedSearchCount · integer · default: 0

Number of tracked searches. Tracked searches are search requests where the clickAnalytics parameter is true.

Example:

2

abtests. clickSignificance · number<double> | null

A/B test significance calculated from click events.

Values of 0.95 or higher can be considered significant, that is, the difference between A and B variants is not due to random variations. Lower values have a.

Example:

1

abtests. conversionSignificance · number<double> | null

A/B test significance calculated from conversion events.

Values of 0.95 or higher can be considered significant, that is, the difference between A and B variants is not due to random variations.

Example:

1

abtests. addToCartSignificance · number<double> | null

A/B test significance calculated from add-to-cart events.

Values of 0.95 or higher can be considered significant, that is, the difference between A and B variants is not due to random variations.

Example:

1

abtests. purchaseSignificance · number<double> | null

A/B test significance calculated from purchase events.

Values of 0.95 or higher can be considered significant, that is, the difference between A and B variants is not due to random variations.

Example:

1

abtests. revenueSignificance · object

A/B test significance calculated from revenue data.

Values of 0.95 or higher can be considered significant, that is, the difference between A and B variants is not due to random variations.

Show child attributes

abtests.revenueSignificance. {key} · number<double>

Example:

{ "USD": 1, "EUR": 0.87 }

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. featureFilters · object

Configuration of feature-based filters applied to the A/B test population.

Show child attributes

abtests.configuration.featureFilters. dynamicReRanking · boolean

Whether to apply Dynamic Re-Ranking feature filters.

abtests.configuration.featureFilters. aiPerso · boolean

Whether to apply AI Personalization feature filters.

abtests.configuration.featureFilters. multiSignalRanking · boolean

Whether to apply Multi-Signal Re-Ranking feature filters.

abtests.configuration. outliers · object

Configuration for handling outliers.

Show child attributes

abtests.configuration.outliers. exclude · boolean · default: true

Whether to exclude outliers when calculating A/B test results.

abtests.configuration. emptySearch · object

Configuration for handling empty searches.

Show child attributes

abtests.configuration.emptySearch. exclude · boolean

Whether to exclude empty searches when calculating A/B test results.

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

count · integer · required

Number of A/B tests.

Example:

10

total · integer · required

Number of retrievable A/B tests.

Example:

12