get_unit_vacancy_detail_report
Generate a detailed unit vacancy report. Filter by property, group, portfolio, or owner using numeric IDs, and select columns like rent, status, and amenities.
Instructions
Generates a report on unit vacancies. IMPORTANT: All ID parameters (owners_ids, properties_ids, etc.) must be numeric strings (e.g. '123'), NOT names. Use respective directory reports first to lookup IDs by name if needed.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| properties | No | Filter results based on properties, groups, portfolios, or owners. All ID fields must be numeric strings, not names. | |
| property_visibility | No | Filter units by status. Defaults to "active" | active |
| tags | No | Optional. Filter by a comma-separated list of tags (e.g., "bbq,deck"). | |
| columns | No | Array of specific columns to include in the report. Valid columns: advertised_rent, posted_to_website, posted_to_internet, property, property_name, amenities, lockbox_enabled, affordable_program, address, street, street2, city, state, zip, unit, unit_tags, unit_type, bed_and_bath, sqft, unit_status, rent_ready, days_vacant, last_rent, schd_rent, new_rent, last_move_in, last_move_out, available_on, next_move_in, description, amenities_price, computed_market_rent, ready_for_showing_on, unit_turn_target_date, advertised_rent_months, property_id, unit_id. If not specified, all columns are returned. |