Stop A/B test

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

Required API Key: any key with the editSettings ACL

Method signature

$analytics->stopABTest(integer abTestID)

analytics.stop_ab_test(Integer abTestID)

analytics.stopABTest(integer abTestID)

analytics.stop_ab_test(int abTestID)

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

suspend fun ClientAnalytics.stopABTest(
    abTestID: ABTestID,
    requestOptions: RequestOptions? = null
): RevisionABTest

analytics.StopABTest(int abTestID)

analytics.stopABTest(int abTestID)

analytics.StopABTest(int abTestID)

stop abTest abTestID

See code examples

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#

Copy

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

$analytics->stopABTest(42);

1
2
analytics = Algolia::Analytics::Client.create('AJ0P3S7DWQ', '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb')
response = analytics.stop_ab_test(42)

1
2
3
4
5
6
7
8
9
const analytics = client.initAnalytics({
  // optional parameters
  region: 'de',
  appId: 'AJ0P3S7DWQ',
  apiKey: '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb',
});
analytics.stopABTest(42).then(({ abTestID }) => {
  console.log(abTestID);
});

1
2
3
4
5
6
analytics = AnalyticsClient.create(
    'AJ0P3S7DWQ',
    '••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb'
)

analytics.stop_ab_test(42)

1
2
3
4
5
analyticsClient.stopABTest(withID: 42) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
AnalyticsClient analytics = new AnalyticsClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");
analytics.StopABTest(42);

// Asynchronous
await analytics.StopABTestAsync(42);

1
2
3
4
5
6
7
AnalyticsClient analytics = 
DefaultAnalyticsClient.create("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb");

StopAbTestResponse res = analytics.stopABTest(42);

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

1
2
client := analytics.NewClient("AJ0P3S7DWQ", "••••••••••••••••••••ce1181300d403d21311d5bca9ef1e6fb")
res, err := client.StopABTest(42)

Parameters # A


            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#

Copy

          {
  "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?

Stop A/B test

About this method # Found an issue? Edit this page A Edit this page

Examples # Found an issue? Edit this page A Edit this page

Stop an A/B test#

Parameters # Found an issue? Edit this page A Edit this page

Response # Found an issue? Edit this page A Edit this page

JSON format#

On this page

About this method # A

Examples # A

Parameters # A

Response # A