Skip to main content

Get rolling-window KPIs for a listing.

GET 
/listings/:listing_id/kpis

Returns rolling-window performance metrics covering the full Wheelhouse metrics lexicon. Each metric is an object keyed by period strings such as "0_7" (next 7 days), "0_30" (next 30 days), "30_0" (past 30 days), etc.

Bidirectional metrics (periods 7/14/21/30/60/90/180/365, both past and future): adr, adr_fees, asking_rate, asking_rate_fees, asking_rate_highest, asking_rate_lowest, bookings, last_booked_days, lead_time, length_of_stay, min_price_occurrence, nights_available, nights_blocked, nights_bookable, nights_booked, nights_calendar, nights_percent_open, occupancy, occupancy_adjusted, revenue, revenue_available, revenue_blocked, revenue_fees, revenue_fees_taxes, revpar, revpar_adjusted_occupancy, revpar_adjusted_occupancy_fees, revpar_fees.

Forward-only metrics (periods 7/14/21/30/60/90/180/365, future only): occupancy_neighborhood, occupancy_neighborhood_pp, occupancy_neighborhood_ratio, occupancy_neighborhood_adjusted, occupancy_neighborhood_adjusted_pp, occupancy_neighborhood_adjusted_ratio, revenue_score.

Backward-only metrics (periods 7/14/21/30/60/90/180/365, past only): pickup, pickup_bookings.

Comp-set metrics (periods 7/30/60, forward only): comp_set_occupancy, comp_set_occupancy_adjusted, comp_set_revenue.

Scalars: comp_set_count.

A metric field is null when it has not been generated yet for the listing; individual period keys are null where the metric does not apply or the window has no data. All monetary values are in the listing's currency.

Request​

Responses​

Rolling-window KPIs.