API client / Methods / A/B Test
Required API Key: any key with the setSettings ACL
Method signature
$analytics->stopABTest(integer abTestID)

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

About this method # A

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 # A

Stop an A/B test#

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

$analytics->stopABTest(42);

Parameters # A

Parameter Description
abTestID #
type: integer
Required

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

Response # A

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#

1
2
3
4
5
{
  "abTestID": 78,
  "taskID": 111885720
  "index": "atis-abtest-default",
}
Field Description
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?
PHP v3