Metric

Delete a metric definition

Changed on

Archives (soft-deletes) a custom metric definition, addressed by its UUID or its stable slug. The metric is hidden from all reads and stops being collected, but its record and previously collected values are retained. System metrics cannot be deleted. Fails with 409 if the metric is still used as a source by a derived metric (delete those first).

delete/v1/metric/definitions/{idOrSlug}

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/metric/definitions/{idOrSlug}
  • Auth
    HTTP bearer

Path parameters

idOrSlugstring required

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

Response

The metric definition was archived

Changes