Sign in
Metrics

Update a metric description.

patch/v2/metrics/{metric_id}

Path parameters

metric_idstring required

LedgerUp metric identifier.

Example:metric_0194f4e3a2b77c6aa91c4f6b4db2a980

Resource identifier.

Request body

descriptionstring nullable required

Optional description. Send null to clear.

Example request

{
  "description": "Usage tracked for Acme."
}

Response

Updated.

idstring required

LedgerUp metric identifier.

namestring required

Human-readable name. Maximum 256 Unicode scalar values.

descriptionstring nullable required

Optional description. Maximum 2048 Unicode scalar values.

measurement_unitsstring nullable required

Optional unit of measure for the metric, such as m, ft, seconds, or tokens.

created_atinteger required

Unix timestamp in seconds.

updated_atinteger required

Unix timestamp in seconds.

archived_atinteger required

Unix timestamp in seconds.

Example response

{
  "id": "metric_0194f4e3a2b77c6aa91c4f6b4db2a980",
  "name": "Acme",
  "description": "Usage tracked for Acme.",
  "measurement_units": "m",
  "created_at": 1767225600,
  "updated_at": 1767225600,
  "archived_at": 1767225600
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.