Skip to main content

V1RecommendationRun

Top-level response for POST /v1/recommendations.

run_id is a fresh UUID — V1 is a pure function and its output is not persisted server-side.

run_iduuidrequired
company_iduuidrequired
business_datedaterequired

Server clock day at the moment of computation.

currencyCurrencyrequired

ISO-4217 currency code on the company.

recommendations object[]required
  • Array [
  • datedaterequired
    current_rate object

    The hotel's current rate for this day, sourced from the is_self=true competitor-pricing row. Null when no self pricing has been ingested for this date.

    anyOf
    string

    Possible values: Value must match regular expression ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

    market_rate object

    The market reference rate for this day. Currently always null — no real backing source is wired yet. Will populate when the data source is available.

    anyOf
    string

    Possible values: Value must match regular expression ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

    competitor_rate object

    Average rate across the company's competitor set for this day. Null when no competitor pricing has been ingested.

    anyOf
    string

    Possible values: Value must match regular expression ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

    recommended_rateRecommended Raterequired

    V1 engine output, rounded to 2 decimals.

    Possible values: Value must match regular expression ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

    justificationJustificationrequired

    Human-readable explanation of how the recommended rate was derived. Suitable for display in a partner dashboard.

  • ]
  • warningsstring[]
    computed_atdate-timerequired
    V1RecommendationRun
    {
    "run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "business_date": "2024-07-29",
    "currency": "string",
    "recommendations": [
    {
    "date": "2024-07-29",
    "current_rate": "string",
    "market_rate": "string",
    "competitor_rate": "string",
    "recommended_rate": "string",
    "justification": "string"
    }
    ],
    "warnings": [
    "string"
    ],
    "computed_at": "2024-07-29T15:51:28.071Z"
    }