/v1/metrics/portfolioAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request GET \
--url 'https://api.staging.facily.ai/v1/metrics/portfolio' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"org_id": "00000000-0000-4000-8000-000000000001",
"ar_aging": {
"total": "<VALUE_MATCHING_PATTERN>",
"billed_ahead": "<VALUE_MATCHING_PATTERN>",
"tenant_count": 0
},
"autopay": {
"attempts_30d": 0,
"enrolled": 0,
"failed_attempts_30d": 0,
"suspended": 0,
"success_rate_30d": "<VALUE_MATCHING_PATTERN>"
},
"computed_at": "2026-10-29T12:00:00Z",
"delinquency": {
"total_ar_delinquent": "<VALUE_MATCHING_PATTERN>",
"total_delinquent": 0,
"by_stage": [
{}
],
"cured_30d": 0,
"opened_30d": 0,
"recovery_rate_30d": "<VALUE_MATCHING_PATTERN>"
},
"disputes": {
"open_amount": "<VALUE_MATCHING_PATTERN>",
"open_count": 0
},
"facility_breakdown": [
{
"active_leads": 0,
"code": "string",
"collected_mtd": "<VALUE_MATCHING_PATTERN>",
"delinquent_count": 0,
"id": "00000000-0000-4000-8000-000000000001",
"name": "string",
"occupancy_rate": "<VALUE_MATCHING_PATTERN>"
}
],
"facility_count": 0,
"occupancy": {
"available": 0,
"maintenance": 0,
"move_ins_30d": 0,
"move_outs_30d": 0,
"net_movement_30d": 0,
"occupied": 0,
"overlocked": 0,
"reserved": 0,
"total_units": 0,
"by_size": [
{
"available": 0,
"occupied": 0,
"total": 0,
"depth_feet": "<VALUE_MATCHING_PATTERN>",
"width_feet": "<VALUE_MATCHING_PATTERN>"
}
],
"by_type": [
{
"available": 0,
"avg_standard_rate": "<VALUE_MATCHING_PATTERN>",
"name": "string",
"occupancy_rate": "<VALUE_MATCHING_PATTERN>",
"occupied": 0,
"reserved": 0,
"revenue": "<VALUE_MATCHING_PATTERN>",
"total": 0,
"facility_count": 0,
"unit_type_id": "00000000-0000-4000-8000-000000000001"
}
],
"occupancy_rate": "<VALUE_MATCHING_PATTERN>"
},
"pipeline": {
"active_leads": 0,
"leads_today": 0,
"contact_rate_30d": "<VALUE_MATCHING_PATTERN>",
"conversion_rate_30d": "<VALUE_MATCHING_PATTERN>",
"lead_rates": {
"month": {
"abandoned_checkouts": 0,
"abandoned_recovered": 0,
"conversions": 0,
"direct_move_ins": 0,
"first_touch_count": 0,
"first_touch_seconds": 0,
"prospects": 0,
"touch_eligible": 0,
"touched": 0
},
"prior": {
"abandoned_checkouts": 0,
"abandoned_recovered": 0,
"conversions": 0,
"direct_move_ins": 0,
"first_touch_count": 0,
"first_touch_seconds": 0,
"prospects": 0,
"touch_eligible": 0,
"touched": 0
},
"by_source": [
{
"month_conversions": 0,
"month_prospects": 0,
"prior_conversions": 0,
"prior_prospects": 0,
"source": "string"
}
]
},
"lead_trend": [
{
"count": 0,
"day": "2026-10-29",
"source": "string"
}
],
"leads_by_source": [
{}
],
"leads_by_status": [
{}
],
"leads_month_to_date": 0,
"open_reservations": 0
},
"retail": {
"items": [
{
"item_id": "00000000-0000-4000-8000-000000000001",
"revenue_mtd": "0.00",
"revenue_prior_mtd": "0.00",
"units_mtd": 0
}
],
"low_stock_count": 0,
"revenue_mtd": "0.00",
"revenue_prior_mtd": "0.00",
"top_item_id": "00000000-0000-4000-8000-000000000001",
"units_mtd": 0
},
"revenue": {
"collected_last_month": "<VALUE_MATCHING_PATTERN>",
"collected_mtd": "<VALUE_MATCHING_PATTERN>",
"credit_balance": "<VALUE_MATCHING_PATTERN>",
"fees_mtd": "<VALUE_MATCHING_PATTERN>",
"rent_roll": "<VALUE_MATCHING_PATTERN>",
"autopay_coverage_pct": "<VALUE_MATCHING_PATTERN>",
"collected_last_month_to_date": "<VALUE_MATCHING_PATTERN>"
}
},
"meta": {
"request_id": "string"
}
}application/json
dataPortfolioMetricsResponse | nullrequiredShow data schema
PortfolioMetricsResponse | nullVariant 1: PortfolioMetricsResponse
ar_agingPortfolioArAgingMetrics | nullShow ar_aging schema
PortfolioArAgingMetrics | nullVariant 1: PortfolioArAgingMetrics
billed_aheadstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tenant_countinteger | nulltotalstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Variant 2: null
nullautopayAutopayMetrics | nullShow autopay schema
AutopayMetrics | nullVariant 1: AutopayMetrics
attempts_30dintegerrequiredenrolledintegerrequiredfailed_attempts_30dintegerrequiredsuccess_rate_30dstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
suspendedintegerrequiredVariant 2: null
nullcomputed_atstring | nullFormat: date-time
Show computed_at schema
string | nullVariant 1: string
stringVariant 2: null
nulldelinquencyDelinquencyMetrics | nullShow delinquency schema
DelinquencyMetrics | nullVariant 1: DelinquencyMetrics
by_stageobject[]cured_30dintegerDefault: 0
opened_30dintegerDefault: 0
recovery_rate_30dstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_ar_delinquentstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_delinquentintegerrequiredVariant 2: null
nulldisputesDisputeMetrics | nullShow disputes schema
DisputeMetrics | nullVariant 1: DisputeMetrics
open_amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
open_countintegerrequiredVariant 2: null
nullfacility_breakdownFacilityBreakdownItem[]Show facility_breakdown schema
active_leadsintegerrequiredcodestringrequiredcollected_mtdstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
delinquent_countintegerrequiredidstringrequiredFormat: uuid
namestringrequiredoccupancy_ratestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
facility_countintegerDefault: 0
occupancyOccupancyMetrics | nullShow occupancy schema
OccupancyMetrics | nullVariant 1: OccupancyMetrics
availableintegerrequiredby_sizeUnitSizeRollup[]by_typeUnitTypeRollup[]maintenanceintegerrequiredmove_ins_30dintegerrequiredmove_outs_30dintegerrequirednet_movement_30dintegerrequiredoccupancy_ratestring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
occupiedintegerrequiredoccupied_revenuestring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
overlockedintegerrequiredreservedintegerrequiredrevenue_per_sqftstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_sqftstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_unitsintegerrequiredVariant 2: null
nullorg_idstringrequiredFormat: uuid
pipelinePipelineMetrics | nullShow pipeline schema
PipelineMetrics | nullVariant 1: PipelineMetrics
active_leadsintegerrequiredcontact_rate_30dstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
conversion_rate_30dstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
lead_ratesLeadRates | nullLead counts for the month to date and the prior month.
lead_trendLeadTrendPoint[]Leads opened per local day and source since the 1st of the month two back; non-zero cells.
leads_by_sourceobject[]Live leads per lead source, largest first, as {source, count}: source is the source's name, or null for the one group of leads with no source.
leads_by_statusobject[]The facility's leads counted by status.
leads_month_to_dateintegerLeads created since the start of the facility's month.
Default: 0
leads_todayintegerrequiredopen_reservationsintegerLeads in reserved status; one past its expiry counts until it is closed, within 15 minutes.
Default: 0
Variant 2: null
nullretailRetailMetrics | nullShow retail schema
RetailMetrics | nullVariant 1: RetailMetrics
itemsRetailItemMetrics[]Each item sold this month or over the same days of last month.
low_stock_countintegerItems whose stock is below their low-stock line.
Default: 0
revenue_mtdstringRetail sales since the start of the month, before tax.
Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
revenue_prior_mtdstringRetail sales over the same days of last month, before tax.
Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
top_item_idstring | nullThe item with the most sales this month, if any sold.
Format: uuid
units_mtdintegerUnits sold since the start of the month.
Default: 0
Variant 2: null
nullrevenueRevenueMetrics | nullShow revenue schema
RevenueMetrics | nullVariant 1: RevenueMetrics
autopay_coverage_pctstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
collected_last_monthstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
collected_last_month_to_datestring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
collected_mtdstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
credit_balancestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
fees_mtdstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
rent_rollstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Variant 2: null
nullrevenue_managementRevenueManagementMetrics | nullShow revenue_management schema
RevenueManagementMetrics | nullVariant 1: RevenueManagementMetrics
active_promotion_idsstring[]leases_on_promotionintegerDefault: 0
notices_undeliveredintegerScheduled or held increases whose notice could not be delivered.
Default: 0
promotion_avg_discount_pctstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
promotion_discount_mtdstringDefault: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
promotion_discounted_rent_mtdstringDefault: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
promotions_activeintegerDefault: 0
raises_heldintegerIncreases held at their effective date because the notice was late.
Default: 0
raises_on_noticeintegerRent increases scheduled and not yet in effect.
Default: 0
raises_pending_annualstringThe same, over a year.
Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
raises_pending_monthlystringMonthly rent those increases add once in effect.
Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
rates_last_changed_atstring | nullFormat: date-time
street_avg_weightedstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
street_priced_unitsintegerDefault: 0
web_avg_weightedstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
web_priced_unitsintegerDefault: 0
Variant 2: null
nulltenantsTenantsMetrics | nullShow tenants schema
TenantsMetrics | nullVariant 1: TenantsMetrics
past_due_countintegerrequiredtotal_activeintegerrequireduninsured_countintegerrequiredVariant 2: null
nullVariant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired