Skip to content

Metric commands: update, delete

The Metric Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Metric, one group of Metric commands.

Metric.update

Changes the given properties of a Metric. Verb page.

Text
npx startup-builder do Metric.update --json '<input>' [--try | --send | --do]

Emits Metric.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Metric.
querytextHow it is computed. An agent never varies the Metrics it is judged by. Never randomized.
unitstringThe unit, such as dollars or percent.

Returns

OutputTypeRequiredDescription
metricMetricrequiredThe Metric.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Metric.update --json '{"id":"metric_GXFHAlK100","query":"Example query"}'

Metric.delete

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

Text
npx startup-builder do Metric.delete --json '<input>' [--try | --send | --do]

Emits Metric.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Metric.

Returns

OutputTypeRequiredDescription
metricMetricrequiredThe Metric.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Metric.delete --json '{"id":"metric_GXFHAlK100"}'