Stop an A/B test

Stops an A/B test by its ID.

You can’t restart stopped A/B tests.

POST /3/abtests/{id}/stop

curl

cURL

curl --request POST \
  --url https://analytics.us.algolia.com/3/abtests/224/stop \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

200

{
  "index": "delcourt_production",
  "abTestID": 224,
  "taskID": 1514562690001
}

Required ACL: editSettings

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

id · integer · required

Unique A/B test identifier.

Example:

224

Response

200

application/json

OK

index · string · required

Index name of the A/B test variant (case-sensitive).

Example:

"delcourt_production"

abTestID · integer · required

Unique A/B test identifier.

Example:

224

taskID · integer<int64> · required

Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this task ID.

Example:

1514562690001