Reports

Yield Insights

Aggregated occupancy and revenue insights for a site's yield pricing — where the peak and quiet spells are, and what yield rules have earned since they were switched on.

The YieldInsights object

Attributes

  • periodstringrequired

    The reporting period the insights were calculated over.

    Possible values:last_30_dayslast_60_dayslast_90_days
  • windowobjectrequirednullable

    The concrete datetime window the requested period resolved to, or null when the site has no occupancy history at all to build a window from. When the site's data starts too recently to cover the whole requested period, starts_at reflects where the data actually begins rather than the full period.

  • currencystringrequired

    The ISO-4217 currency code every monetary amount in this response (performance.additional_revenue, performance.aov_uplift_amount) is denominated in. The amounts themselves are integers in this currency's minor units.

  • has_occupancy_databooleanrequired

    Whether the site has any occupancy data at all. When false there is nothing to calculate insights from, so the stat fields elsewhere in the response are null.

  • is_yield_enabledbooleanrequired

    Whether yield pricing is switched on for the site. When false the performance stats have nothing to measure and are null.

  • opportunitiesobjectrequired

    Where the opportunity for demand-based pricing lies — how busy the site runs on average, and how many peak and quiet spells its occupancy shows over the reporting window.

  • performanceobjectrequired

    What yield pricing earned the site over the selected window, against what the same sales would have made at their pre-yield baseline prices. Monetary amounts are integers in the minor units of the top-level currency — format them client-side. Every amount is signed rather than clamped: rules that discount into quiet periods genuinely take less than baseline, and say so.

{
  "period": "last_30_days",
  "window": {
    "starts_at": "2026-01-15T09:30:00+00:00",
    "ends_at": "2026-01-15T09:30:00+00:00"
  },
  "currency": "GBP",
  "has_occupancy_data": true,
  "is_yield_enabled": true,
  "opportunities": {
    "has_data": true,
    "avg_utilisation_percent": 68,
    "bookable_area_count": 4,
    "peak_period_count": 9,
    "quiet_period_count": 23,
    "peak_threshold_percent": 90,
    "quiet_threshold_percent": 40
  },
  "performance": {
    "has_data": true,
    "additional_revenue": 648000,
    "additional_revenue_since": "2026-01-15",
    "aov_uplift_amount": 1420,
    "aov_uplift_percent": 11,
    "aov_caveat": {
      "type": "low_order_count",
      "value": 6,
      "threshold": 20,
      "message": "Based on 6 orders, fewer than the 20 needed for a reliable average."
    },
    "bookings_at_high_peak_count": 36,
    "bookings_by_tier": [
      {
        "tier": "low",
        "count": 110,
        "share_percent": 22,
        "revenue": 1190000
      }
    ]
  }
}