Readout commands: update, delete
The Readout Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Readout, one group of Readout commands.
Readout.update
Changes the given properties of a Readout. Verb page.
npx startup-builder do Readout.update --json '<input>' [--try | --send | --do]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
npx startup-builder do Readout.update --json '{"id":Readout.delete
Deletes a Readout: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Readout.delete --json '<input>' [--try | --send | --do]Emits Readout.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Readout. |
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
npx startup-builder do Readout.delete --json '{"id":