API Reference / API Methods / A/B Test / Delete A/B test
Feb. 26, 2019

Delete A/B test

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

About this method

Delete an A/B test

Deletes the A/B Test from your application and removes all associated metadata & metrics. You will therefore no longer be able to view or access the results.

Note that deleting a test is different from stopping: When you delete a test, all associated metadata and metrics are deleted.

Examples

Delete an A/B test

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

$analytics->deleteABTest(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": 111887230,
  "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?