Skip to main content
PATCH
PATCH /v1/metrics/{id}

Update a Metric

Update a metric using an RFC 6902 JSON Patch. Address the metric by UUID or fully qualified name.

Update by ID

string
required
UUID of the metric to update.

Update by Fully Qualified Name

Use PATCH /v1/metrics/name/{fqn} to update by name.
string
required
Fully qualified name of the metric, such as customer_retention_rate.

Body Parameters

Send an array of JSON Patch operations with the application/json-patch+json content type.
string
required
Patch operation, such as add, replace, or remove.
string
required
JSON Pointer path of the field to change, such as /description or /metricExpression/code.
JSON value
New value for add and replace operations. Omit it for remove.
PATCH /v1/metrics/{id}

Returns

Returns the updated metric with an incremented version.
Fetch relationship fields before modifying them with an SDK. This gives the SDK a complete baseline from which to calculate additions and removals.

Error Handling