Sign in
Metric

Update a metric definition

Update the editable subset of a custom metric definition, addressed by its UUID or its stable slug. Only the supplied fields are changed; omitted fields are left unchanged. Every update creates a new immutable version; the response carries the advanced versionId. System metrics and immutable fields (scope, outputType, calcType, …) are rejected. Which fields are editable depends on the metric (e.g. derived metrics only allow name).

put/v1/metric/definitions/{idOrSlug}

Path parameters

idOrSlugstring required

The metric definition's Roark ID (UUID) or its stable slug (e.g. customer_satisfaction).

Request body

namestring

New name (only for metrics whose name is editable)

llmPromptstring

New LLM prompt (only for LLM_JUDGE metrics whose prompt is editable)

scaleMininteger

New scale minimum (SCALE output only)

scaleMaxinteger

New scale maximum (SCALE output only)

booleanTrueLabelstring

New label for the true case (BOOLEAN output only)

booleanFalseLabelstring

New label for the false case (BOOLEAN output only)

maxClassificationsinteger

New maximum number of classifications (CLASSIFICATION output only)

toolDefinitionIdsstring[]

Replacement set of scoped tool-definition ids (only for metrics whose tool scoping is editable)

supportedContextsstring[]

Replacement set of supported contexts. Omit to leave unchanged.

formulastring

New formula expression (FORMULA only). Pass sources alongside if the referenced metrics change.

changeReasonstring

Optional free-text audit note recorded on the new version.

{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:slug","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:metricId","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:source","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:organizationId","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:projectId","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:outputType","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:scope","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:participantRole","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:calcType","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:supportsMultipleVariants","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:UpdateMetricDefinitionInput:properties:analysisPackageId","oasType":"schema","type":"unknown"}

Response

The updated metric definition (with versionId advanced to the new version)

Changes

Changed in 1 of the 105 revisions of this API.1