Metric

Get a metric definition

Changed on

Fetch a single metric definition by its UUID or its stable slug (e.g. customer_satisfaction). Resolution is scoped to the project — a project-owned metric wins over an org-wide one, which wins over a system metric of the same slug.

get/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

Changes

    • breaking

      added to the response property oneOf list for the response status

    • info

      added HTTP_REQUEST discriminator mapping keys to the response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status