API client / Methods / A/B Test

Jun. 08, 2023

List A/B tests

Required API Key: any key with the analytics ACL

Method signature

$analytics->getABTests()
$analytics->getABTests([
  // All the following parameters are optional
  'offset' => integer,
  'limit' => integer,
])

analytics.get_ab_tests()

analytics.get_ab_tests(Hash opts = {
  Integer offset: 0,
  Integer limit: 10,
})

analytics.getABTests({
  offset: integer,
  limit: integer,
  indexPrefix: string,
  indexSuffix: string
})

analytics.get_ab_tests()
analytics.get_ab_tests({
  // All the following parameters are optional
  'offset': int,
  'limit': int
})

analyticsClient.listABTests(
  offset: Int?,
  limit: Int?,
  requestOptions: RequestOptions? = nil,
  completion: Result<ABTestsResponse> -> Void
)

suspend fun ClientAnalytics.listABTests(
    page: Int? = null,
    hitsPerPage: Int? = null,
    requestOptions: RequestOptions? = null
): ResponseABTests

analytics.GetABTests(int offset, int limit)

analytics.getABTests(int offset, int limit)

client.GetABTests()
client.GetABTests(
  opt.Offset(int offset),
  opt.Limit(int limit),
)

get all abTests
get all abTests offset offset limit limit

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

List A/B tests information and results.

Examples

Read the Algolia CLI documentation for more information.

List all A/B test

Copy

1
2
3
4
5
6
7
8
9
$analytics = AnalyticsClient::create(
  'YourApplicationID',
  'YourWriteAPIKey'
);

$analytics->getABTests([
  'offset' => 10,
  'limit' => 20
]);

1
2
3
4
5
6
7
8
9
const analytics = client.initAnalytics({
  // optional parameters
  region: 'de',
  appId: 'YourApplicationID',
  apiKey: 'YourWriteAPIKey',
});
analytics.getABTests({ limit: 1, offset: 10 }).then(({ abtests }) => {
  console.log(abtests);
});

1
2
3
4
5
6
analyticsClient.listABTests(offset: 10,
                            limit: 20) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
AnalyticsClient analytics = new AnalyticsClient("YourApplicationID", "YourWriteAPIKey");

var abTests = analytics.GetABTests(10, 20);

// Asynchronous
var abTests = await analytics.GetABTestsAsync(10, 20);

1
2
3
4
5
6
7
AnalyticsClient analytics = 
DefaultAnalyticsClient.create("YourApplicationID", "YourWriteAPIKey");

ABTests abtests = analytics.getABTests(10, 20);

// Asynchronous
CompletableFuture<ABTests> abtests = analytics.getABTests(10, 2);

1
2
3
4
5
6
7
opts := []interface{}{
  opt.Offset(10),
  opt.Limit(20),
}

client := analytics.NewClient("YourApplicationID", "YourWriteAPIKey")
res, err := client.GetABTests(opts...)

Parameters

Parameter	Description
`offset`	type: integer default: 0 Optional Offset
`limit`	type: integer default: 10 Optional Limit
`indexPrefix`	type: string Optional Filter for A/B tests. Return A/B test variants for which the index name starts with `indexPrefix`.
`indexSuffix`	type: string Optional Filter for A/B tests. Return A/B test variants for which the index name ends with `indexSuffix`.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

Copy

          {
  "count": 1,
  "total": 1,
  "abtests": [
    {
      "abtestID": 102,
      "name": "ABTest custom name",
      "createdAt": "2018-06-04T10:25:40.459519Z",
      "endAt": "2018-06-11T23:59:59Z",
      "status": "active",
      "configuration": {
        "outliers": {
          "exclude": true
        },
        "emptySearch": {
          "exclude": false
        },
      },
      "variants": [
        {
          "averageClickPosition": null,
          "clickCount": null,
          "clickThroughRate": null,
          "conversionCount": null,
          "conversionRate": null,
          "description": "my current scenario description",
          "index": "scout_airports",
          "noResultCount": null,
          "searchCount": null,
          "trackedSearchCount": null,
          "trafficPercentage": 61,
          "userCount": null,
          "trackedUserCount": null,
          "filterEffects": {
            "outliers": {
              "usersCount": 0,
              "trackedSearchesCount": 0
            }
          }
        },
        {
          "averageClickPosition": null,
          "clickCount": null,
          "clickThroughRate": null,
          "conversionCount": null,
          "conversionRate": null,
          "description": "the test scenarios is based on locations",
          "index": "airport_demo_airports",
          "noResultCount": null,
          "searchCount": null,
          "trackedSearchCount": null,
          "trafficPercentage": 39,
          "userCount": null,
          "trackedUserCount": null,
          "filterEffects": {
            "outliers": {
              "usersCount": 1,
              "trackedSearchesCount": 300
            }
          }
        }
      ],
      "clickSignificance": null,
      "conversionSignificance": null
    }
  ]
}

        

Field	Description
`count`	integer Number of A/B tests returned.
`total`	integer Total number of A/B tests that can be fetched.
`abtests`	List of abTest

abTest

Field	Description
`abTestID`	integer ID of the A/B test.
`clickSignificance`	float A/B test significance based on click data. Should be > 0.95 to be considered significant (no matter which variant is winning).
`conversionSignificance`	float A/B test significance based on conversion data. Should be > 0.95 to be considered significant (no matter which variant is winning)
`purchaseSignificance`	float A/B test significance based on `purchase` conversions. Should be greater than 0.95 to be considered significant, no matter which variant is winning.
`addToCartSignificance`	float A/B test significance based on `addToCart` conversions. Should be greater than 0.95 to be considered significant, no matter which variant is winning.
`revenueSignificance`	object A/B test revenue significance for each currency. The object has currency codes as keys and significance scores as values. The object has currency codes as keys and significance scores as values.
`createdAt`	string Time at which the A/B test has been created. The date will be in the following format: `Y-m-d\TH:i:s\Z`
`endAt`	string Time at which the A/B test will automatically stop. The date will be in the following format: `Y-m-d\TH:i:s\Z`
`name`	string Name of the A/B test.
`status`	string Current status of the A/B test.
`variants`	list of variant List of 2 variants: The base index The index to test against
`configuration`	configuration object Configuration parameters for the A/B test. { "outliers": outliers object, "emptySearch": emptySearch object "minimumDetectableEffect": minimumDetectableEffect object }

variants ➔ variant

Field	Description
`averageClickPosition`	int Average click position for the variant.
`clickCount`	int Distinct click count for the variant.
`clickThroughRate`	float Click through rate for the variant.
`conversionCount`	int Distinct conversion count for the variant.
`conversionRate`	float Conversion rate for the variant.
`addToCartCount`	int Distinct number of converted clicks with the `eventSubtype` set to `addToCart` and `clickAnalytics` set to `true`.
`addToCartRate`	float Add-to-cart rate is based on conversion events that have `eventSubType` set to `addToCart`, and the total number of tracked searches within the specified timeframe. The rates are computed as the number of add-to-cart conversion events divided by the number of tracked searches.
`purchaseCount`	int Distinct number of converted clicks with the `eventSubtype` set to `purchase` and `clickAnalytics` set to `true`.
`purchaseRate`	float Purchase rate is based on conversion events that have `eventSubType` set to `purchase`, and the total number of tracked searches within the specified timeframe. The rates are computed as the number of purchase conversion events divided by the number of tracked searches.
`description`	string Description of this variant.
`estimatedSampleSize`	int Estimated number of searches needed to achieve confidence for this variant. This number is pre-computed and is based on the `minimumDetectableEffect` configuration parameter.
`index`	string Index name for this variant.
`noResultCount`	int Number of tracked searches without any results.
`searchCount`	int Total number of searches for this variant, including untracked searches.
`trackedSearchCount`	int Number of tracked searches. Tracked searches are searches with `clickAnalytics` enabled.
`userCount`	int Total number of users who searched this variant, including untracked users.
`trackedUserCount`	int Number of users who searched this variant with at least one search that had `clickAnalytics` enabled.
`currencies`	object Revenue metrics for each currency. { "USD": currency object, "EUR": currency object }
`filterEffects`	filterEffects object Effects of the configuration filters applied to the variant. { "outliers": filterEffect, "emptySearch": filterEffect }

➔ currency object

Field	Description
`currency`	string Currency code in ISO 4217 format.
`revenue`	float Revenue made in this currency.
`mean`	float Mean revenue for this currency.
`standardDeviation`	float Standard deviation of revenue for this currency.

➔ configuration object

Field	Description
`outliers`	outliers object Configuration for outlier exclusion from metrics calculations.
`emptySearch`	emptySearch object Configuration for empty search exclusion from metrics calculations.
`minimumDetectableEffect`	minimumDetectableEffect object Configuration for minimum detectable effect.

configuration ➔ outliers object

Field	Description
`exclude`	boolean Whether outliers are excluded when calculating A/B test results. Outliers will always be excluded by default unless explicitly set to false.

configuration ➔ emptySearch object

Field	Description
`exclude`	boolean Whether empty searches are excluded when calculating A/B test results.

configuration ➔ minimumDetectableEffect object

Field Description


          size

float

Required

The size of the minimum detectable effect. This is the smallest relative difference between the variants that you want to be able to detect. For example, if you want to be able to detect a 10% difference between the variants, you should set this to 0.1. The size must be between 0 and 1.


          effect

string