Metric.watch

Its Inputs, Outputs, Effects and guards quote the hub’s Metric.watch; 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; Metric.watched 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

A guardrail Metric that trips stops its Experiment at once, with no delay window.

Emits

Metric.watched with { metric }

Performed by

Analyst

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 Metric.watched delivers the result.

Tell me if the reply rate drops under 3%.

{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Metric.watch",
    "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

• Workflows: Weekly readout
• Jobs: Convert visitors · Keep and grow customers · Measure

RelatedCopy Anchor Link

• Metric.queryReads a number from your Events as a trend, funnel, retention curve or path, split by any property.
• Experiment.startSplits traffic across your variants and starts measuring the primary and guardrail numbers.
• 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.