Skip to main content

V2RecommendationRun

Top-level response for any /v2/recommendations* endpoint.

run_iduuidrequired
company_iduuidrequired
business_datedaterequired
currencyCurrencyrequired
fallback_usedFallback Used
Default value: false
recommendations object[]required
  • Array [
    • datedaterequired
    room_typeRoom Typerequired
    recommended_rateRecommended Raterequired

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

    delta_pctDelta Pctrequired

    Percent diff vs the room's current rate at compute time.

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

    confidenceConfidencerequired

    Policy confidence in [0, 1].

    phasePhaserequired

    DISTRESSED | BUILD | YIELD | SPIKE | …

    drivers object[]
  • Array [
    • featureFeaturerequired

    Feature name (e.g. pace_index).

    labelLabelrequired

    Humanised feature name for display.

    impactImpactrequired

    Contribution magnitude.

    directionDirectionrequired

    up | down.

  • ]
    • guardrails object[]
  • Array [
    • codeCoderequired

    Machine-readable guardrail code.

    labelLabelrequired

    Humanised label for display.

  • ]
    • hitl_requiredHitl Required
    Default value: false
    explanation object
    anyOf
    string
  • ]
    • warningsstring[]
    computed_atdate-timerequired
    V2RecommendationRun
    {
      "run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "business_date": "2024-07-29",
      "currency": "string",
      "fallback_used": false,
      "recommendations": [
        {
          "date": "2024-07-29",
          "room_type": "string",
          "recommended_rate": "string",
          "delta_pct": "string",
          "confidence": 0,
          "phase": "string",
          "drivers": [
            {
              "feature": "string",
              "label": "string",
              "impact": 0,
              "direction": "string"
            }
          ],
          "guardrails": [
            {
              "code": "string",
              "label": "string"
            }
          ],
          "hitl_required": false,
          "explanation": "string"
        }
      ],
      "warnings": [
        "string"
      ],
      "computed_at": "2024-07-29T15:51:28.071Z"
    }