Remove Experiment

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/i/ab-testing/remove-experiment

Overview

Delete an experiment and its associated data, including variant cohorts.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

• Delete (ab_testing feature)

Request Parameters

Parameter	Type	Required	Description
api_key	String	Yes (or use auth_token)	API key for authentication
auth_token	String	Yes (or use api_key)	Auth token for authentication
app_id	String	Yes	Application identifier
experiment_id	String	Yes	Experiment ObjectId to remove

Examples

Example 1: Remove an Experiment

Request:

curl "https://your-server.com/i/ab-testing/remove-experiment" \
  -d "api_key=YOUR_API_KEY" \
  -d "app_id=YOUR_APP_ID" \
  -d "experiment_id=5f9c8a3b4d1e2a001f3b4567"

Response

Success Response

{
  "result": "Success"
}

Response Fields

Field	Type	Description
result	String	Result message

Error Responses

• HTTP 400 - Missing app_id:

{
  "result": "Missing app_id"
}

• HTTP 400 - Missing experiment_id:

{
  "result": "Missing experiment_id"
}

• HTTP 500 - Experiment does not exist:

{
  "result": "The experiment does not exist."
}

• HTTP 500 - Failed to remove:

{
  "result": "Failed to remove experiment"
}

Behavior

• Deletes the experiment document from countly_out.ab_testing_experiments{appId}.
• Deletes cohorts created for variants and removes cohort data.
• Attempts to remove experiment assignments from countly.app_users{appId}.

Related Endpoints

• Start Experiment
• Stop Experiment
• Reset Experiment

Implementation details

Database Collections

Collection	Used for	Data touched by this endpoint
countly_out.ab_testing_experiments{appId}	Primary:	Removes experiment document.
countly.cohorts	Related:	Deletes all cohorts associated with experiment variants.
countly.cohortdata	Related:	Removes cohort membership data.
countly.app_users{appId}	Related:	Removes experiment assignments from user documents.