Read Demand forecast

GET

/v1/object-types/hospitality.demand_forecast/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.demand_forecast/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Read an existing instance.

One demand-forecast point: for a property and an arrival night, as of an instant, the rooms and ADR a segment is expected to realise, and — when the forecaster estimated it — the unconstrained demand behind them (demand_rooms, which may exceed capacity) and the rooms on the books when the forecast was made. Immutable: a re-forecast is a new point. Every point recorded feeds forecast_point, so the night-audit realization sweep grades it against the actual once the night has matured.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.demand_forecast:read

Parameters

Path Parameters

required

string format: uuid

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

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

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.demand_forecast

properties

required

object

arrival_date

required

The arrival night forecast

string format: date

demand_rooms

Unconstrained demand in rooms, when estimated (may exceed capacity)

string format: decimal

external_ref

Replay key for the forecasting source (unique per tenant while present)

string

forecast_adr

required

Demand forecast forecast adr

Average daily rate expected on the night

object

amount

required

string format: decimal

currency

required

string format: iso-4217

forecast_as_of

required

When the forecast was made (business time)

string format: date-time

forecast_rooms

required

Rooms expected to be sold on the night

integer

required

Forecast point id

string

notes

How the forecast was made

string

on_the_books

Rooms already on the books for the night when the forecast was made

integer

segment

required

Market segment forecast, or `total` for the house as a whole

string

Allowed values: total transient group contract

source

required

Who produced the forecast

string

Allowed values: desk rms import

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.demand_forecast",
  "properties": {
    "segment": "total",
    "source": "desk"
  },
  "scope": {
    "level": "tenant"
  }
}

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

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