Skip to content
aerandil.com
GitHub

Read Metric definition

GET
/v1/object-types/hospitality.metric_definition/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.metric_definition/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

A governed, versioned business-metric definition: the disambiguating prose (description / formula_expression) plus a structured reference list over registered object types and fields, so the definition cannot silently reference a field that doesn’t exist. Versioned per name and superseded in place (prior versions live in the event history); certify_metric records operator sign-off, and a deprecated version only returns via revise_metric at a strictly greater version. The executable complement for kernel-conformed metrics lives in the MetricDef registry (/v1/metrics/{name}); this object is the certification layer NL-analytics and agents ground against.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “Query Parameters”
branch
string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.metric_definition
properties
required
object
authored_by
required
Principal::stable_id() of the defining / revising principal
string
certified_at
When this version was certified (set by certify_metric)
string format: date-time
certified_by
Principal::stable_id() of the certifying sign-off
string
description
required
Disambiguating prose — the definition operators sign off on
string
display_name
required
Display name
string
formula_expression
required
Canonical formula expression (governed prose, not executed)
string
grain
required
Organisational-unit × period grain the metric is defined over
string
Allowed values: property_day property_month venue_day venue_month outlet_day brand_month portfolio_month tenant_month
id
required
Definition id
string
name
required
Metric name (snake_case; matches a registry metric when one exists)
string
owner
required
Accountable team / principal for the definition
string
referenced_fields
required
Registered `type.property` fields the formula reads
Array<string>
referenced_object_types
required
Registered object-type names the formula reads
Array<string>
status
required
Certification lifecycle status
string
Allowed values: draft certified deprecated
unit
required
Unit the metric's value carries
string
Allowed values: money ratio percent count hours native_unit
version
required
Monotonic version per name (revise_metric bumps it)
integer
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
Example
{
  "object_type": "hospitality.metric_definition",
  "properties": {
    "grain": "property_day",
    "status": "draft",
    "unit": "money"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “Headers”
ETag
string
/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

Section titled “404”

No object with that id (or soft-deleted).