What-if Define metric (rollup delta)

POST

/v1/actions/hospitality.action.define_metric/whatif

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_metric/whatif \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "description": "example", "display_name": "example", "formula_expression": "example", "grain": "property_day", "name": "example", "owner": "example", "referenced_fields": [ "example" ], "referenced_object_types": [ "example" ], "unit": "money" }, "return_modified": false }'

• Production API

What-if projection of apply_hospitality_action_define_metric — previews the action (execute-and-roll-back) and folds its would-be events into rollup deltas, returning the contribution an apply would make to the daily_rooms fact (ADR / RevPAR / TRevPAR / Occupancy inputs) without persisting anything. Requires the same actions:hospitality.action.define_metric:apply scope as apply. An action that emits no rooms-fact events yields an empty daily_rooms.

Authorizations

• aerandil_oauth

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

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

string

Allowed values: property_day property_month venue_day venue_month outlet_day brand_month portfolio_month tenant_month

name

required

Stable metric name (snake_case)

string

owner

required

Accountable team / principal for the definition

string

referenced_fields

required

Registered `<object_type>.<property>` fields the formula reads

Array<string>

referenced_object_types

required

Registered object-type names the formula reads

Array<string>

unit

required

Unit the metric's value carries

string

Allowed values: money ratio percent count hours native_unit

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

Responses

200

Rollup deltas the action would contribute, computed and rolled back.

Media typeapplication/json

object

daily_rooms

required

Per (property, business_date) additive contribution to the rooms rollup.

Array<object>

object

business_date

required

string format: date

currency

ISO 4217, when the fold observed one.

string

property_id

required

string format: uuid

rooms_revenue_net_delta

required

Decimal, net rooms revenue delta.

string

rooms_sold_delta

required

integer format: int64

total_revenue_net_delta

required

Decimal, net total revenue delta.

string

Example^generated

{
  "daily_rooms": [
    {
      "business_date": "2026-04-15",
      "currency": "example",
      "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "rooms_revenue_net_delta": "example",
      "rooms_sold_delta": 1,
      "total_revenue_net_delta": "example"
    }
  ]
}

Headers

Cache-Control

string

Allowed value: no-store

Always no-store — derived, uncommitted data.

422

Validation error — the apply would be rejected.