v1
latestOpenAPI 3.0.32026-07-26120117318.1 KBCreate an experiment
Creates a new experiment. Returns 201 with the created experiment and Location header.
Request body
Experiment display name.
Stable identifier for the experiment. Alphanumeric, hyphens, underscores, dots. Max 64 characters.
Optional experiment description.
Percentage of users to include in the experiment.
Primary success metric.
Target value for the primary metric.
Desired direction of change.
Context key for context-specific experiments.
Whether this experiment is restricted to a specific context.
Response
Experiment created.
Experiment identifier (server-generated UID).
Canonical API path.
Experiment display name.
User-facing stable identifier (supplied on POST, immutable after). Added in the DEV-777 response audit; was missing from the public envelope despite being accepted on create.
Experiment description.
Current experiment status.
ISO 8601 timestamp when the experiment was started.
ISO 8601 timestamp when the experiment was finished.
Percentage of users included in the experiment.
Primary success metric. Legacy experiments created before the underscore naming may return hyphenated variants (e.g. user-to-trial, subscription-cancellation); treat them as read-only and migrate to the underscore form before sending them back on PATCH.
Target value for the primary metric.
Desired direction of change for the primary metric.
Context key for context-specific experiments.
Whether this experiment is restricted to a specific context.
ISO 8601 creation timestamp.
ISO 8601 last update timestamp.
Example response
{
"object": "experiment",
"alias_id": "paywall_ab_test_v3"
}