Skip to main content

List All Experiments

Endpoint​

/o?method=ab-testing

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

Overview​

List AB testing experiments for an app. For running experiments, this endpoint recalculates performance metrics unless skipCalculation=true.

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​

  • Read (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 ID
skipCalculationStringNoSet to true to skip live performance recalculation

Response​

Success Response​

{
	"experiments": [],
	"performance_metrics": [
		{
			"value": "improvement"
		},
		{
			"value": "conversion_rate"
		},
		{
			"value": "probability_beat_baseline"
		},
		{
			"value": "conversion_number"
		}
	]
}

Response Fields​

FieldTypeDescription
experimentsArrayExperiment documents for the app
performance_metricsArraySupported metric keys (improvement, conversion_rate, etc.)

Error Responses​

Authentication/permission failures are returned by the common rights layer.

Behavior/Processing​

  • Fetches experiments from countly_out.ab_testing_experiments{appId}.
  • For running experiments, recalculates results unless skipCalculation=true.
  • Updates stored results when recalculation runs.

Database Collections​

CollectionUsed forData touched by this endpoint
countly_out.ab_testing_experiments{appId}Primary:Experiment definitions and results.

Examples​

Example 1: List experiments with recalculation​

Request:

curl "https://your-server.com/o?method=ab-testing&app_id=YOUR_APP_ID&api_key=YOUR_API_KEY"

Response:

{
	"experiments": [],
	"performance_metrics": [
		{"value": "improvement"},
		{"value": "conversion_rate"},
		{"value": "probability_beat_baseline"},
		{"value": "conversion_number"}
	]
}

Example 2: List experiments without recalculation​

Request:

curl "https://your-server.com/o?method=ab-testing&app_id=YOUR_APP_ID&skipCalculation=true&api_key=YOUR_API_KEY"

Response:

{
	"experiments": [],
	"performance_metrics": [
		{"value": "improvement"},
		{"value": "conversion_rate"},
		{"value": "probability_beat_baseline"},
		{"value": "conversion_number"}
	]
}

Limitations​

  • Use skipCalculation=true for dashboard lists that do not need fresh metrics.
  • Recalculation can be expensive for large datasets.

Ⓔ 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