Yield Insights

Returns a site-level summary of how yield pricing is set up and performing over a recent reporting period: the opportunity for demand-based pricing (utilisation, peak and quiet spells) and what yield rules have earned since they were switched on.

The four state flags (has_occupancy_data, is_yield_enabled, opportunities.has_data, performance.has_data) are always present, so a dashboard can decide which panels to render before reading any stats. The stat fields themselves are null until the underlying calculation has data to work from.

Monetary amounts are integers in the minor units of the top-level currency — format them client-side.

For a per-sale breakdown of every price a yield rule moved, use the yielded sales report.

Returns how full a site's bookable capacity was by weekday and hour over a recent reporting period, so an operator can see when demand is heavy enough to price against.

Each average is the share of bookable minutes that were booked in that weekday and hour across the period — booked time over usable capacity, with time blocked out by staff reducing capacity rather than counting as demand. An average is null rather than 0 where nothing was bookable, so a closed hour reads differently from an empty one.

type selects which offerings the averages cover.

has_occupancy_data is always present, so a dashboard can decide whether to render the grid before reading it. heatmap is empty until the underlying calculation has data to work from.

Separate from the yield insights summary because type scopes only the grid: a dashboard switching between offering types re-reads this without re-reading the summary.

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.

Returns how full each of a site's bookable resources was by hour over a recent reporting period, so an operator can see which rooms carry the demand and which sit empty.

Each average is the share of that resource's bookable minutes which were booked in that hour across the period, with time blocked out by staff reducing capacity rather than counting as demand. An average is null rather than 0 where nothing was bookable, so a closed hour reads differently from an empty one.

Rows cover treatment rooms today; kind distinguishes them from bookable areas, which are added as further rows once their capacity is measured.

avgs is empty until the underlying calculation has data to work from, while the rows themselves are always returned, so a grid can render its axes before any fill rate exists.