YieldInsights

Get the yield insights revenue comparison

Returns what the site took over the reporting period against what the same bookings would have made at baseline prices, as the two lines of a chart plus the overall uplift between them.

has_data needs both occupancy history and yield rules — with no rules there is nothing to compare against. series is empty until the underlying calculation has data to work from.

Separate from the yield insights summary because it returns a series rather than a stat. For the single since-inception figure, read performance.additional_revenue there instead.

Amounts are integers in the minor units of the top-level currency. Sites without the advanced_yield_management feature respond 404.

get/shop/yield-insights/revenue-comparison

Query parameters

site_idstring uuid required

The site to return yield insights for.

period'last_30_days' | 'last_60_days' | 'last_90_days'
Example:last_30_days

The reporting period to calculate results over, ending now. Defaults to last_30_days. Shared by the yield insights endpoints so a dashboard can request every panel over the same window.

Response

The revenue comparison was successfully retrieved.

Example response

{
  "data": {
    "period": "last_30_days",
    "currency": "GBP",
    "has_data": true,
    "uplift_percent": 14,
    "series": [
      {
        "date": "2026-07-06",
        "revenue_with_yield": 1234000,
        "revenue_without_yield": 1180000
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.