get_occupancy_summary_report
Generate an occupancy summary report with number of units, occupied units, and vacancy rates. Filter by properties, groups, portfolios, or owners.
Instructions
Generates a summary of property occupancy, including number of units, occupied units, and vacancy rates. IMPORTANT: All ID parameters must be numeric strings (e.g. '123'), NOT names. Use directory reports to lookup IDs by name if needed. Common columns: 'number_of_units', 'occupied', 'vacant_rented', 'vacant_unrented', 'percent_occupied'.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| properties | No | Filter results based on properties, groups, portfolios, or owners | |
| unit_visibility | No | Filter units by status. Defaults to "active" | active |
| as_of_date | Yes | The "as of" date for the report (YYYY-MM-DD). Required. | |
| columns | No | Array of specific columns to include in the report. Valid columns: unit_type, number_of_units, occupied, percent_occupied, average_square_feet, average_market_rent, vacant_rented, vacant_unrented, notice_rented, notice_unrented, average_rent, property, property_id. If not specified, all columns are returned. NOTE: Use 'occupied' for occupied units count, 'vacant_rented' and 'vacant_unrented' for vacancy details. |