Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Headers

Tenant-ID
string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. Pass your own internal customer ID for the tenant. Ignored for single-tenant organisations.

Path Parameters

id
string<uuid>
required

The UUID of the metric to retrieve.

Response

Successful operation

A successfully created metric returned from the create endpoint.

id
string<uuid>
required

The UUID of the created metric.

name
string
required

The metric name.

key
string
required

The metric key.

unitType
enum<string>
required

The metric unit type.

Available options:
number,
currency
units
string
required

The stored units value for the metric.