Experiment.start

Its Inputs, Outputs, Effects and guards quote the hub’s Experiment.start; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Analytics and experiments.

InputsCopy Anchor Link

OutputsCopy Anchor Link

EffectsCopy Anchor Link

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes

• try: Runs every check and returns the record as it would be; nothing is stored.
• send: Returns a pending Action at once; Experiment.started fires when it is done.
• do: Waits for the Action to finish and returns the record.

Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

The Experiment is saved as the call leaves it, with the Action that changed it.

Emits

Experiment.started with { experiment }

Performed by

Whichever seat calls it

Price

Free on your own account: the platform charges nothing for the call.

On each VenueCopy Anchor Link

It acts on your own records and reaches no Venue, so every account answers the same way.

What try doesCopy Anchor Link

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses whenCopy Anchor Link

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

When it waitsCopy Anchor Link

Returns in one response; nothing waits.

ExampleCopy Anchor Link

In send mode the call returns its pending Action at once, and Experiment.started delivers the result.

Start the subject-line test on the first touch.

{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Experiment.start",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used byCopy Anchor Link

• Agent tasks: Message test

RelatedCopy Anchor Link

• Metric.queryReads a number from your Events as a trend, funnel, retention curve or path, split by any property.
• Metric.watchOpens a Task, or sends you a Message, the day a number crosses the line you set.
• Experiment.concludeEnds an Experiment with ship, kill or iterate, recorded as a Decision with its reason.
• Dashboard.askAnswers a plain question with a query over your records, the query shown beside the answer.
• Metric.defineCompiles a number from your Events and lists every Event it reads, so no one types it in.
• Event.captureRecords one Event from your Site or product, such as a signup, so every number above can read it.
• Hypothesis.testTies a Hypothesis to the Experiment that decides it, and marks it testing.
• Dashboard.scheduleSends a Dashboard on a schedule to a Mailbox, a Channel or an agent’s context.