Get 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.
Query parameters
The site to return yield insights for.
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 yield insights were successfully retrieved.
Example response
{
"data": {
"period": "last_30_days",
"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,
"aov_uplift_amount": 1420,
"aov_uplift_percent": 11,
"bookings_at_high_peak_percent": 36,
"bookings_by_tier": [
{
"tier": "low",
"count": 110,
"share_percent": 22,
"revenue": 1190000
}
]
}
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.