Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Portfolio Metrics
Search the full API reference Esc to close

Get Portfolio Metrics

Reports · REST API reference

Get support
GET/v1/metrics/portfolio

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request 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
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/metrics/portfolio' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

GET requests only. Your key’s permissions and facility scope still apply.

Response
Your response will appear here.

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "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 | nullrequired
Show data schema
PortfolioMetricsResponse | null
Variant 1: PortfolioMetricsResponse
ar_agingPortfolioArAgingMetrics | null
Show ar_aging schema
PortfolioArAgingMetrics | null
Variant 1: PortfolioArAgingMetrics
billed_aheadstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

tenant_countinteger | null
totalstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Variant 2: null
null
autopayAutopayMetrics | null
Show autopay schema
AutopayMetrics | null
Variant 1: AutopayMetrics
attempts_30dintegerrequired
enrolledintegerrequired
failed_attempts_30dintegerrequired
success_rate_30dstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

suspendedintegerrequired
Variant 2: null
null
computed_atstring | null

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
delinquencyDelinquencyMetrics | null
Show delinquency schema
DelinquencyMetrics | null
Variant 1: DelinquencyMetrics
by_stageobject[]
cured_30dinteger

Default: 0

opened_30dinteger

Default: 0

recovery_rate_30dstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

total_ar_delinquentstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

total_delinquentintegerrequired
Variant 2: null
null
disputesDisputeMetrics | null
Show disputes schema
DisputeMetrics | null
Variant 1: DisputeMetrics
open_amountstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

open_countintegerrequired
Variant 2: null
null
facility_breakdownFacilityBreakdownItem[]
Show facility_breakdown schema
active_leadsintegerrequired
codestringrequired
collected_mtdstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

delinquent_countintegerrequired
idstringrequired

Format: uuid

namestringrequired
occupancy_ratestringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

facility_countinteger

Default: 0

occupancyOccupancyMetrics | null
Show occupancy schema
OccupancyMetrics | null
Variant 1: OccupancyMetrics
availableintegerrequired
by_sizeUnitSizeRollup[]
by_typeUnitTypeRollup[]
maintenanceintegerrequired
move_ins_30dintegerrequired
move_outs_30dintegerrequired
net_movement_30dintegerrequired
occupancy_ratestring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

occupiedintegerrequired
occupied_revenuestring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

overlockedintegerrequired
reservedintegerrequired
revenue_per_sqftstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

total_sqftstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

total_unitsintegerrequired
Variant 2: null
null
org_idstringrequired

Format: uuid

pipelinePipelineMetrics | null
Show pipeline schema
PipelineMetrics | null
Variant 1: PipelineMetrics
active_leadsintegerrequired
contact_rate_30dstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

conversion_rate_30dstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

lead_ratesLeadRates | null

Lead 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_dateinteger

Leads created since the start of the facility's month.

Default: 0

leads_todayintegerrequired
open_reservationsinteger

Leads in reserved status; one past its expiry counts until it is closed, within 15 minutes.

Default: 0

Variant 2: null
null
retailRetailMetrics | null
Show retail schema
RetailMetrics | null
Variant 1: RetailMetrics
itemsRetailItemMetrics[]

Each item sold this month or over the same days of last month.

low_stock_countinteger

Items whose stock is below their low-stock line.

Default: 0

revenue_mtdstring

Retail sales since the start of the month, before tax.

Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

revenue_prior_mtdstring

Retail sales over the same days of last month, before tax.

Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

top_item_idstring | null

The item with the most sales this month, if any sold.

Format: uuid

units_mtdinteger

Units sold since the start of the month.

Default: 0

Variant 2: null
null
revenueRevenueMetrics | null
Show revenue schema
RevenueMetrics | null
Variant 1: RevenueMetrics
autopay_coverage_pctstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

collected_last_monthstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

collected_last_month_to_datestring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

collected_mtdstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

credit_balancestringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

fees_mtdstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

rent_rollstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Variant 2: null
null
revenue_managementRevenueManagementMetrics | null
Show revenue_management schema
RevenueManagementMetrics | null
Variant 1: RevenueManagementMetrics
active_promotion_idsstring[]
leases_on_promotioninteger

Default: 0

notices_undeliveredinteger

Scheduled or held increases whose notice could not be delivered.

Default: 0

promotion_avg_discount_pctstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

promotion_discount_mtdstring

Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

promotion_discounted_rent_mtdstring

Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

promotions_activeinteger

Default: 0

raises_heldinteger

Increases held at their effective date because the notice was late.

Default: 0

raises_on_noticeinteger

Rent increases scheduled and not yet in effect.

Default: 0

raises_pending_annualstring

The same, over a year.

Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

raises_pending_monthlystring

Monthly rent those increases add once in effect.

Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

rates_last_changed_atstring | null

Format: date-time

street_avg_weightedstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

street_priced_unitsinteger

Default: 0

web_avg_weightedstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

web_priced_unitsinteger

Default: 0

Variant 2: null
null
tenantsTenantsMetrics | null
Show tenants schema
TenantsMetrics | null
Variant 1: TenantsMetrics
past_due_countintegerrequired
total_activeintegerrequired
uninsured_countintegerrequired
Variant 2: null
null
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll reports operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Get Portfolio Metrics | Facily Developers