Read Rate recommendation run

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.rate_recommendation_run/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.rate_recommendation_run/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

Batched parent of one cadence’s worth of recommendations — rate moves and sell restrictions alike — issued by an agent against a property. Append-only, immutable post-finalisation per §B.2 (matching night_audit_run and channel_mix_snapshot semantics). The four denormalised counters (recommendations_count, applied_count, rejected_count, expired_count) are §B.1 projections refreshed by the lifecycle actions; recommendations_count_computed_at is the refresh pair.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.rate_recommendation_run: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.rate_recommendation_run

properties

required

object

agent_model

Model variant if the vendor exposes it

string

agent_vendor

required

Agent vendor (denormalised from Principal::Agent.vendor)

string

agent_version

required

Agent version (denormalised from Principal::Agent.version)

string

applied_count

Count of recommendations applied (denormalised; §B.1)

integer

cadence

required

Cadence

string

Allowed values: nightly intraday hourly event_triggered manual

expired_count

Count of recommendations expired (denormalised; §B.1)

integer

failure_reason

Set on status = failed

string

finished_at

When the run finalised — set on completed / failed

string format: date-time

required

Run id

string

recommendations_count

Count of recommendations issued in this run (denormalised; §B.1)

integer

recommendations_count_computed_at

Refresh pair for the four counters (§B.1 discipline)

string format: date-time

rejected_count

Count of recommendations rejected (denormalised; §B.1)

integer

started_at

required

When the run opened

string format: date-time

status

required

Status

string

Allowed values: in_progress completed failed

target_horizon_days

required

Forecast horizon the run looked over

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.rate_recommendation_run",
  "properties": {
    "cadence": "nightly",
    "status": "in_progress"
  },
  "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).