Preview the per-night oversell a unit type would apply over a date range. Runs the same rule evaluation the distribution
pipeline uses and returns, per night, the availability, booked count, computed oversell and resulting rooms-to-sell.
| Parameter |
Type |
Required |
Description |
unitTypeId |
string |
Yes |
The ID of the unit type (multi-unit group) to preview |
from |
string |
Yes |
Start date of the preview range (inclusive), as an ISO8601 date (e.g. “2026-09-01”) |
to |
string |
Yes |
End date of the preview range (inclusive), as an ISO8601 date (e.g. “2026-09-30”) |
| Field |
Type |
Description |
content |
ContentItem[] |
Array of content items returned by the tool - ContentItem |
isError |
boolean |
Whether the tool execution resulted in an error |
| Field |
Type |
Description |
type |
'text' |
Content type (currently only ‘text’ is supported) |
text |
string |
The text content to display |
