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
The reporting period the insights were calculated over.
Possible values:last_30_dayslast_60_dayslast_90_daysThe concrete datetime window the requested
periodresolved to, ornullwhen 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_atreflects where the data actually begins rather than the full period.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.Whether the site has any occupancy data at all. When
falsethere is nothing to calculate insights from, so the stat fields elsewhere in the response arenull.Whether yield pricing is switched on for the site. When
falsetheperformancestats have nothing to measure and arenull.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.
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.