Create 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/add-experiment

Overview

Create a new AB testing experiment in drafts status. Drafts can be updated until the experiment is started.

Authentication

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

Permissions

• Create (ab_testing feature)

Request Parameters

Content-Type: application/x-www-form-urlencoded

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	String (JSON)	Yes	JSON-stringified object describing the experiment

experiment Object

• name (String, required): Experiment name.
• description (String, optional): Experiment description.
• variants (Array, required): Two or more variants. Each variant includes:
  • name (String): Variant name.
  • parameters (Array): Parameter objects with name, value, description.
• target_users (Object, required):
  • percentage (String): 0-100 percentage of users to include.
  • condition (Object or JSON String): Drill filter for segmentation.
• goals (Array, required): Each goal includes:
  • steps (Array or JSON String): Event sequence to track.
  • user_segmentation (Object or JSON String): Additional goal filter.
• improvement (Boolean, optional): Enable improvement tracking.
• improvementRate (Number, optional): 0-100 baseline improvement percentage.
• days (Number, optional): 1-3650 duration in days.

Examples

Example 1: Create Button Color Test Experiment

Request:

curl "https://your-server.com/i/ab-testing/add-experiment" \
  -d "api_key=YOUR_API_KEY" \
  -d "app_id=YOUR_APP_ID" \
  -d 'experiment={"name":"Button Color Test","description":"Testing CTA button colors for conversion optimization","variants":[{"name":"Control","parameters":[{"name":"button_color","value":"blue","description":"Original blue button"}]},{"name":"Red Button","parameters":[{"name":"button_color","value":"red","description":"Test red button variant"}]}],"target_users":{"percentage":"50","condition":"{}"},"goals":[{"steps":[{"type":"did","event":"click_button"}],"user_segmentation":"{}"}],"improvement":true,"improvementRate":10,"days":30}'

Response:

"5f9c8a3b4d1e2a001f3b4567"

Example 2: Create Pricing Page Test with Segmentation

Request:

curl "https://your-server.com/i/ab-testing/add-experiment" \
  -d "api_key=YOUR_API_KEY" \
  -d "app_id=YOUR_APP_ID" \
  -d 'experiment={"name":"Pricing Page Layout","description":"Testing different pricing page layouts","variants":[{"name":"Current Layout","parameters":[{"name":"layout_type","value":"standard","description":""}]},{"name":"Simplified Layout","parameters":[{"name":"layout_type","value":"minimal","description":""}]}],"target_users":{"percentage":"100","condition":"{\"query\":{\"up.country\":{\"$in\":[\"US\",\"CA\"]}}}"},"goals":[{"steps":[{"type":"did","event":"purchase"}],"user_segmentation":"{}"}],"days":60}'

Response:

"5f9c8a3b4d1e2a001f3b4568"

Response

Success Response

"5f9c8a3b4d1e2a001f3b4567"

Response Fields

Field	Type	Description
(root value)	String	Created experiment ID

Error Responses

• HTTP 400 - Invalid parameters:

{
  "result": "Invalid parameter: improvementRate"
}

• HTTP 400 - Invalid parameters:

{
  "result": "Invalid parameter: days"
}

• HTTP 400 - Incomplete request:

{
  "result": "Incomplete request"
}

• HTTP 400 - Invalid goals:

{
  "result": "Invalid data: goals"
}

• HTTP 500 - Parameter name conflict:

{
  "result": "The parameter has been added to drafts or running experiments."
}

• HTTP 500 - Variant validation failed:

{
  "result": "Invalid variant: missing name"
}

• HTTP 500 - Referenced remote-config parameter does not exist:

{
  "result": "The parameter does not exists"
}

• HTTP 500 - Experiment limit reached (max 100):

{
  "result": "Experiment limit reached"
}

• HTTP 500 - Creation failed:

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

Behavior

• Validates experiment payload (limits, goals, variant schema, and parameter existence).
• Inserts experiment as drafts and returns created experiment ID.

Limitations

• Minimum 2 variants, maximum 8 variants.
• Variant parameter count must be the same across all variants.
• Maximum 8 parameters per variant.
• Maximum 3 goals per experiment.

Related Endpoints

• Update Experiment
• Start Experiment
• Remove Experiment
• List All Experiments

Implementation details

Database Collections

Collection	Used for	Data touched by this endpoint
countly_out.ab_testing_experiments{appId}	Primary:	Stores experiment configurations, variants, targets, goals, and status.