Skip to main content
POST
/
properties
/
bulk
/
quota_impact
Bulk Properties Quota Impact
curl --request POST \
  --url https://data.apartmentiq.io/apartmentiq/api/v2/properties/bulk/quota_impact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "{account_id}"
}
'
{
  "total_quota": 5000,
  "consumed_quota": 1280,
  "requested_records": 50,
  "new_records": 32,
  "prev_records": 18,
  "expected_new_consumed_quota": 1312
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request contract for calculating property bulk export quota impact without recording export usage.

​
account_id
required

ApartmentIQ account ID used to set the request account context.

​
interval
enum<string>

Optional period bucket for requested metrics. Omit for one summary row per property.

Available options:
month,
quarter,
year
​
fields
enum<string>[]

Optional metric field names. Omit or pass an empty array for identity-only rows.

Metric field to include in each property row.

Available options:
rent,
rent_0_bed,
rent_1_bed,
rent_2_bed,
rent_3_bed,
ner,
ner_0_bed,
ner_1_bed,
ner_2_bed,
ner_3_bed,
rent_psf,
rent_0_bed_psf,
rent_1_bed_psf,
rent_2_bed_psf,
rent_3_bed_psf,
ner_psf,
ner_0_bed_psf,
ner_1_bed_psf,
ner_2_bed_psf,
ner_3_bed_psf,
rent_growth_rate_yoy,
ner_growth_rate_yoy,
concession_value,
concession_percent,
days_on_market,
occupancy_percent,
leased_percent,
exposure_percent
​
property_filters
object

Filters used to select properties and constrain the metric aggregation date range.

​
page
integer
default:1

One-based page number for the export result set.

Required range: x >= 1
​
per_page
integer
default:25

Number of rows per page. Values above the maximum are clamped.

Required range: 1 <= x <= 100

Response

Estimated property bulk export quota impact.

Estimated quota impact for a property bulk export request.

​
total_quota
integer
required

Total property export quota available for the account.

​
consumed_quota
integer
required

Property export quota already consumed before this request.

​
requested_records
integer
required

Number of unique property records included in this request.

​
new_records
integer
required

Requested property records that have not previously consumed quota.

​
prev_records
integer
required

Requested property records that have already consumed quota.

​
expected_new_consumed_quota
integer
required

Projected consumed quota after exporting the new records in this request.