Readout routes: update, delete

Reference for Readout, one group of Readout routes.

Readout.update

Changes the given properties of a Readout. Verb page.

Text

PATCH /{namespace}/readouts/{id}

Path: id. Body, as JSON: the other inputs. Emits Readout.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Readout.
`value`	`number`		The Metric’s value for the Variant.
`n`	`integer`		How many exposed units it counts.
`interval`	`json`		The low and high bounds of the estimate.
`readability`	`string`		One of `A`, `B`, `C`, or `inadmissible`: how far the number can be trusted.
`pooled`	`boolean`		True when exposures from sibling Startups or earlier Portfolio results are pooled in.

Returns

Output	Type	Required	Description
`readout`	Readout	required	The Readout.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/readouts/readout_dlRDxjf2vt \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":1}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "readout": {
    "$id": "https://api.sb/leaseline.app/readouts/readout_dlRDxjf2vt",
    "$type": "Readout",
    "value": 1,
    "n": 1,
    "readability": "A"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Readout.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Readout.delete

Deletes a Readout: a soft delete that keeps its history, undone by Thing.restore. Verb page.