Analyze Renewals
analyze_renewalsLease renewal + below-market rent gap analysis (LeaseExpiration, 76).
Per-property active/m2m/renewed/on-notice counts, expirations in next 30/60/90 days, and the total market-rent-vs-current-rent gap. Plus top-N below-market rents (renewal pricing opportunities) and top-N upcoming expirations. Distinct from lease_expirations (which is API-based and lighter) — this one adds the market-rent column, which is the actual signal needed for pricing decisions.
``location`` (optional): a Rent Manager Location ID, a comma-separated
list, or ``"all"`` to run across every Location on this connection (see
``list_locations``). Blank = all Locations if the connection has several,
else its only Location. Output is labelled per Location; a Location that
can't be reached is listed as skipped. IDs (property, tenant, ...) belong
to one Location, so pass that Location when you filter by one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| top_n | No | ||
| end_date | No | ||
| location | No | ||
| portfolio | No | ||
| as_of_date | No | ||
| start_date | No | ||
| property_ids | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |