get_bookings_hotels_sales_report
Overview
Returns analytics on properties (hotels): per-hotel sales, buying price, profit, and profit margin. Compares the current period to the previous period of equal length. Results are ordered by current-period sales (highest first) and limited by the limit parameter.
When to Use
Property performance - See which hotels drive the most sales and profit
Period comparison - Compare current vs previous period sales, profit, and bookings per hotel
Profit analysis - Track total_buying_price_usd, total_profit_usd, and profit_margin_percent by property
Top properties dashboards - Rank hotels by sales or profit
What You Get
Period definition - Date ranges for current and previous periods
Summary - Totals for sales (USD), profit (USD), bookings, count of hotels in the result, and average profit margin percent; all with period-over-period change
Per-hotel data - For each property: hotel_id, hotel_name, city, country; current and previous period (booking_count, total_sales_usd, avg_booking_value_usd, total_buying_price_usd, total_profit_usd, profit_margin_percent); and change (sales/profit percent and amount, booking_count_change)
New properties - Hotels with no previous-period data have
previous_period: null
Quick Start
Pass query parameters from, to, sandbox, and optionally limit (default controls how many top hotels are returned). The API derives the previous period (same length, immediately before). Returns period metadata, summary totals, and an array of hotel-level metrics.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | End date of the current period YYYY-MM-DD (ISO 8601) | |
| from | Yes | Start date of the current period YYYY-MM-DD (ISO 8601) | |
| limit | No | Maximum number of hotels to return (ordered by current-period sales, highest first) | |
| sandbox | No | Filter by environment: "true" for sandbox, "false" for production |