API Reference / API Methods / A/B Test / Stop A/B test

Stop A/B Test

Required API Key: any key with the setSettings ACL
Method signature
$analytics->stopABTest(integer abTestID)

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

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',
  'YourAdminAPIKey'
);

$analytics->stopABTest(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

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",
}
abTestID
integer

Generated Id of the A/B test.

taskID
integer

The taskID used with the waitTask method.

index
string

Base index name for the A/B test.

Did you find this page helpful?