Sign in

v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
Metric

Update metric

This endpoint allows you to update the metadata property on a metric. If you pass null for the metadata value, it will clear any existing metadata for that invoice.

put/metrics/{metric_id}

Path parameters

metric_idstring required

Request body

metadataobject nullable

User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Response

OK

metadataobject required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

idstring required
namestring required
descriptionstring nullable required
status'active' | 'draft' | 'archived' required
parameter_definitionsobject[] nullable
sqlstring required

The SQL definition of the metric. For metrics defined via configuration rather than SQL, this is a derived SQL representation.