Metric routes: update, delete

Reference for Metric, one group of Metric routes.

Metric.update

Changes the given properties of a Metric. Verb page.

Text

PATCH /{namespace}/metrics/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Metric.
`query`	`text`		How it is computed. An agent never varies the Metrics it is judged by. Never randomized.
`unit`	`string`		The unit, such as dollars or percent.

Returns

Output	Type	Required	Description
`metric`	Metric	required	The Metric.

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/metrics/metric_GXFHAlK100 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"Example query"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "metric": {
    "$id": "https://api.sb/leaseline.app/metrics/metric_GXFHAlK100",
    "$type": "Metric",
    "query": "Example query",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Metric.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Metric.delete

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