Skip to main content
GET
/
2
/
abtests
/
{id}
curl
curl --request GET \
  --url https://analytics.us.algolia.com/2/abtests/224 \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "abTestID": 224,
  "clickSignificance": 1,
  "conversionSignificance": 1,
  "addToCartSignificance": 1,
  "purchaseSignificance": 1,
  "revenueSignificance": {
    "USD": 1,
    "EUR": 0.87
  },
  "updatedAt": "2023-06-15T15:06:44.400601Z",
  "createdAt": "2023-06-15T15:06:04.249906Z",
  "endAt": "2023-06-17T00:00:00Z",
  "stoppedAt": "2023-06-15T15:06:44.400601Z",
  "name": "Custom ranking sales rank test",
  "status": "active",
  "variants": [
    {
      "addToCartCount": 0,
      "addToCartRate": 0,
      "averageClickPosition": 29.12342,
      "clickCount": 65131,
      "clickThroughRate": 0.22219857724813036,
      "conversionCount": 4785,
      "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
        }
      },
      "index": "delcourt_production",
      "noResultCount": 0,
      "purchaseCount": 0,
      "purchaseRate": 0,
      "searchCount": 86269,
      "trackedSearchCount": 2,
      "trafficPercentage": 60,
      "userCount": 55501,
      "trackedUserCount": 55501
    }
  ],
  "configuration": {
    "outliers": {
      "exclude": true
    },
    "emptySearch": {
      "exclude": true
    },
    "minimumDetectableEffect": {
      "size": 0.5,
      "metric": "addToCartRate"
    }
  }
}
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.

Path Parameters

​
id
integer
required

Unique A/B test identifier.

Example:

224

Response

OK

​
abTestID
integer
required

Unique A/B test identifier.

Example:

224

​
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"

​
createdAt
string
required

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

Example:

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

​
endAt
string
required

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

Example:

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

​
name
string
required

A/B test name.

Example:

"Custom ranking sales rank test"

​
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"

​
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.

​
clickSignificance
number | 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

​
conversionSignificance
number | 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

​
addToCartSignificance
number | 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

​
purchaseSignificance
number | 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

​
revenueSignificance
object | null

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.

Example:
{ "USD": 1, "EUR": 0.87 }
​
stoppedAt
string | null

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

Example:

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

​
configuration
object

A/B test configuration.

⌘I