Skip to main content

Reset Experiment

Endpoint​

/i/ab-testing/reset-experiment

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview​

Reset an experiment to draft status. Removes user variant assignments, resets cohort data, and clears stored results.

Authentication​

Authentication Methods:

  • API Key (parameter): api_key=YOUR_API_KEY
  • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions​

  • Delete (ab_testing feature)

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)API key for authentication
auth_tokenStringYes (or use api_key)Auth token for authentication
app_idStringYesApplication identifier
experiment_idStringYesExperiment ObjectId to reset

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringResult message

Error Responses​

  • HTTP 500 - Experiment doesn't exist:
{
  "result": "The experiment does not exist."
}

Behavior/Processing​

  • Removes experiment assignments from countly.app_users{appId}.
  • Rebuilds cohort data for experiment variants.
  • Sets experiment status to drafts and clears results timestamps.

Database Collections​

CollectionUsed forData touched by this endpoint
countly_out.ab_testing_experiments{appId}Primary:Updates experiment status and clears results.
countly.app_users{appId}Related:Removes experiment assignments.
countly.cohortsRelated:Rebuilds cohort data for variants.

Examples​

Example 1: Reset an Experiment​

Request:

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

Ⓔ Enterprise​

This feature is part of Countly Enterprise.

Get Access:

Already a Customer? Use support portal if you have any questions

Last Updated​

2026-02-16