Skip to main content

Reset 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/reset-experiment

Overview

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

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

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

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"

Response

Success Response

{
"result": "Success"
}

Response Fields

FieldTypeDescription
resultStringResult message

Error Responses

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

Behavior

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

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.