Skip to content

Readout

A Readout is an Experiment’s result per Variant on its Metric, with the sample size, the interval, and how far the number can be trusted.

Properties

PropertyTypeRequiredDescription
valuenumberrequiredThe Metric’s value for the Variant.
nintegerrequiredHow many exposed units it counts.
intervaljsonThe low and high bounds of the estimate.
readabilitystringrequiredOne of A, B, C, or inadmissible: how far the number can be trusted.
pooledbooleanTrue when exposures from sibling Startups or earlier Portfolio results are pooled in.

Object

JSON
{
  "$id": "https://api.sb/quietcopy.com/readouts/readout_1",
  "$type": "Readout",
  "value": 1,
  "n": 1,
  "interval": {},
  "readability": "A",
  "pooled": true
}

Relationships

Verbs

  1. createCreates a Readout.
    POST /{namespace}/readoutsdoReadout.created
  2. getReturns one Readout by id.
    GET /{namespace}/readouts/{id}readNo Event
  3. listReturns Readouts, newest first, one page at a time.
    GET /{namespace}/readoutsreadNo Event
  4. updateChanges the given properties of a Readout.
    PATCH /{namespace}/readouts/{id}doReadout.updated
  5. deleteDeletes a Readout; its history is kept.
    DELETE /{namespace}/readouts/{id}doReadout.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Readout.createYesYesYesNo
Readout.getYesYesYesYes
Readout.listYesYesYesYes
Readout.updateYesYesYesNo
Readout.deleteYesYesYesNo

Call it

Text
Add a readout to TutorLoop.

Example

A tutoring Startup reads its two-week pricing Experiment: the challenger converts 4.1% against 3.2% for the control, on 1,900 Exposures, at readability B.