Get A/B Test

Required API Key: any key with the analytics ACL

Method signature

$analytics->getABTest(integer abTestID);

analytics.get_ab_test(Integer abTestID)

analytics.getABTest(integer abTestID)

analytics.get_ab_test(int abTestID)

analyticsClient.getABTest(
  withID abTestID: ABTestID,
  requestOptions: RequestOptions? = nil,
  completion: <Result<ABTestResponse>> -> Void
)

suspend fun ClientAnalytics.getABTest(
    abTestID: ABTestID,
    requestOptions: RequestOptions? = null
): ResponseABTest

analytics.GetABTest(int abTestID)

analytics.getABTest(int abTestID)

client.GetABTest(integer abTestID)

get abTest abTestID

See code examples

About this method

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.

Get an A/B test information and results.

Examples

Read the Algolia CLI documentation for more information.

Get an A/B test

Copy

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

$analytics->getABTest(42);

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

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

ABTest abtest = analytics.getABTest(42);

// Asynchronous
CompletableFuture<ABTes>t abtest = analytics.getABTestAsync(42);

Parameters


            abTestID

type: integer

Required

The A/B test id that was sent back in the response of the add A/B test method

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format

Copy

          {
  "abTestID": 78,
  "clickSignificance": 1,
  "conversionSignificance": 0.9937,
  "createdAt": "2018-05-15T17:52:15.644906Z",
  "endAt": "2018-05-17T23:59:59Z",
  "name": "Custom Ranking salesRank Test",
  "status": "stopped",
  "variants": [
    {
      "averageClickPosition": 0,
      "clickCount": 17115,
      "clickThroughRate": 0.19839107906664039,
      "conversionCount": 11508,
      "conversionRate": 0.13339670101658765,
      "description": "",
      "index": "atis-abtest-default",
      "noResultCount": 0,
      "searchCount": 86269,
      "trackedSearchCount": 86269,
      "trafficPercentage": 70,
      "userCount": 55501
    },
    {
      "averageClickPosition": 0,
      "clickCount": 7716,
      "clickThroughRate": 0.20869847452125934,
      "conversionCount": 5129,
      "conversionRate": 0.13872660391647734,
      "description": "",
      "index": "atis-abtest-salesRank",
      "noResultCount": 0,
      "searchCount": 36972,
      "trackedSearchCount": 36972,
      "trafficPercentage": 30,
      "userCount": 22694
    }
  ]
}

        

`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)
`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

variants ➔ variant

`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)
`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.

Did you find this page helpful?