Get Occupancy & Revenue Stats
get_statsMonthly occupancy and revenue for one apartment, confirmed reservations only — the same numbers as the panel's Statystyki page. apartment_id is required: occupancy/revenue from apartments with different nightly rates can't be meaningfully summed.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"apartment_id": "<apartment_id>"
},
"name": "get_stats"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| months | No | Trailing months to include, defaults to 12. | |
| apartment_id | Yes | Required. From list_apartments. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| help_url | No | Help-center article with step-by-step instructions for this area. Show it to the user when they need to change something in the panel. |