HTTP API
Experiment
Represents an A/B experiment that splits traffic between two or more definition versions of the same agent.
Shape: object
| Property | Required | Type | Description | Rules |
|---|---|---|---|---|
id |
yes | string (uuid) |
Gets the experiment identifier. | — |
tenantId |
yes | string |
Gets the tenant that owns the experiment. | — |
name |
yes | string |
Gets the experiment name. It is unique within the tenant and is used as an API route key. | — |
agentName |
yes | string |
Gets the name of the agent whose traffic is split. | — |
variants |
yes | array of ExperimentVariant |
Gets the experiment variants. Their weights must total 100. | — |
status |
no | ExperimentStatus |
Gets the current experiment status. | — |
assignmentKey |
no | string |
Gets a reserved value. Runtime assignment does not read it: the assignment key is always the session identifier, or the run identifier when no session exists. The property is reserved for future strategies that assign outside a session, and setting it today changes nothing. | — |
startedAt |
no | string (date-time) |
Gets the time when the experiment entered ExperimentStatus.Running. Returns null while it is a draft. |
— |
endedAt |
no | string (date-time) |
Gets the time when the experiment stopped. Returns null when it runs or never started. |
— |
updatedAt |
no | string (date-time) |
Gets the UTC time of the last update. | — |
canary |
no | null oneOf CanaryPolicy |
— | — |
rollbackReason |
no | string |
Gets the reason for an automatic rollback. Returns null when the experiment was stopped manually or was never stopped. |
— |