get_property_performance_report
Retrieve financial performance metrics for properties by specifying date range and report format. Filter by property, owner, or group IDs.
Instructions
Retrieves the Property Performance report, showing financial performance metrics for properties within a specified date range. 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 |
|---|---|---|---|
| property_visibility | No | Filter properties by status. Defaults to "active" | active |
| properties | No | Filter results based on properties, groups, portfolios, or owners. All ID fields must be numeric strings, not names. | |
| report_format | Yes | Format for the property performance report. Required. | |
| period_from | Yes | The start date for the reporting period (YYYY-MM-DD). Required. | |
| period_to | Yes | The end date for the reporting period (YYYY-MM-DD). Required. | |
| columns | No | Array of specific columns to include in the report. Note: Available columns depend on the report_format selected. Avoid generic names like "total_income" - check the API documentation for valid column names for this report. |