Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
summary
/
insurance
Insurance enrollment/occupancy summary
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/summary/insurance \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "facilityUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ],
  "startDate": "2026-04-01",
  "endDate": "2026-04-30"
}
'
[
  {
    "facilityUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "2026-04-01",
    "endDate": "2026-04-30",
    "totalActiveLeases": 120,
    "totalInsuredLeases": 90,
    "pctInsured": 75,
    "newMoveIns": 20,
    "newMoveInsInsured": 15,
    "pctNewMoveInsInsured": 75
  }
]

Headers

x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

Body

application/json
facilityUuids
string<uuid>[]
required

Facility UUIDs to aggregate over (1–1000).

Example:
[
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"3fa85f64-5717-4562-b3fc-2c963f66afa7"
]
startDate
string<date>
required

Inclusive start of the reporting period (ISO date).

Example:

"2026-04-01"

endDate
string<date>
required

Inclusive end of the reporting period (ISO date).

Example:

"2026-04-30"

Response

Insurance summary rows, one per scoped facility.

facilityUuid
string<uuid>
required

Facility UUID this row aggregates.

startDate
string<date>
required

Inclusive start of the reporting period (echoed from request).

Example:

"2026-04-01"

endDate
string<date>
required

Inclusive end of the reporting period (echoed from request).

Example:

"2026-04-30"

totalActiveLeases
number
required

Distinct rentals active at any point in the period (facility-local time).

Example:

120

totalInsuredLeases
number
required

Distinct rentals with non-private coverage active at any point in the period.

Example:

90

pctInsured
number
required

totalInsuredLeases / totalActiveLeases * 100, rounded to 2 decimals. 0 when there are no active leases.

Example:

75

newMoveIns
number
required

Rentals whose start date falls within the period (facility-local time).

Example:

20

newMoveInsInsured
number
required

Of the new move-ins, those with non-private coverage.

Example:

15

pctNewMoveInsInsured
number
required

newMoveInsInsured / newMoveIns * 100, rounded to 2 decimals. 0 when there are no new move-ins.

Example:

75