Stop A/B Test | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

analytics.stopABTest(integer abTestID)

About this method

Stop an A/B test

Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. Additionally, your application is back to normal: index A will perform as usual, receiving 100% of all search requests.

Note that stopping is different from deleting: When you stop a test, all associated metadata and metrics are stored and remain accessible.

Examples

Stop an A/B test

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

$analytics->stopABTest(42);

1
2
analytics = client.init_analytics
response = analytics.stop_ab_test(42)

1
2
3
4
5
6
const analytics = client.initAnalytics();
analytics.stopABTest(42, (err, content) => {
  if (err) throw err;

  console.log(content);
});

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

analytics.stop_ab_test(42)

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

// Asynchronous
await analytics.StopABTestAsync(42);

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

StopAbTestResponse res = analytics.stopABTest(42);

// Asynchronous
CompletableFuture<StopAbTestResponse> res = analytics.stopABTestAsync(42);

1
2
client := analytics.NewClient("YourApplicationID", "YourWriteAPIKey")
res, err := client.StopABTest(42)

1
2
3
client.execute {
  stop abTest 42
}

1
clientAnalytics.stopABTest(ABTestID(42))

Parameters

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
5
{
  "abTestID": 78,
  "taskID": 111885720
  "index": "atis-abtest-default",
}