Sign in

v1

latestOpenAPI 3.1.0AGPL-3.0-only2026-07-1773264353.7 KB
Metrics

Update a billable metric

Partially update metric fields. Code and aggregation_type are immutable.

patch/api/v1/metrics/{metric_id}

Path parameters

metric_idstring MeteroidId required
Example:bm_7n42DGM5Tflk9n8mt7Fhc7

Metric ID

Request body

descriptionstring nullable
namestring nullable

Response

Metric updated

aggregation_keystring nullable
aggregation_type'COUNT' | 'LATEST' | 'MAX' | 'MIN' | 'MEAN' | 'SUM' | 'COUNT_DISTINCT' required
archived_atstring date-time nullable
codestring required
created_atstring date-time required
descriptionstring nullable
idstring MeteroidId required
namestring required
product_family_idstring MeteroidId required
product_idstring MeteroidId
usage_group_keystring nullable

Example response

{
  "id": "bm_7n42DGM5Tflk9n8mt7Fhc7",
  "product_family_id": "pf_7n42DGM5Tflk9n8mt7Fhc7",
  "product_id": "prd_7n42DGM5Tflk9n8mt7Fhc7"
}