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

count · integer · required

Number of A/B tests.

Example:

10

total · integer · required

Number of retrievable A/B tests.

Example:

12