# Get rolling-window KPIs for a listing.

`GET /listings/{listing_id}/kpis`

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/rm-get-listing-kpis · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml · Operation ID: `rmGetListingKpis` · Tag: Listings

Returns rolling-window performance metrics covering the full
[Wheelhouse metrics lexicon](https://www.usewheelhouse.com/research-metrics).
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_available`, `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`.

**Same time last year.** Pass `basis=stly` to get the listing's values as they
stood at the same time last year: each window measured 52 weeks earlier, so
`0_30` is the 30 days that followed the same day last year. The response has the
same shape as `basis=current`. `model_date`, `comp_set_count`, the comp-set
metrics, `revenue_blocked`, `min_price_occurrence`, `revenue_score` and the
`occupancy_neighborhood` metrics are not available for last year and are `null`.
`basis=stly` is in early access; accounts without early access get a 403.

## Request

`GET https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/kpis`

Authentication: send your RM API key in the `X-Integration-Api-Key` header (see https://docs.usewheelhouse.com/rm/authentication.md). Read-only keys can call this endpoint.

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `listing_id` | string | yes | The channel's unique listing identifier, or the Wheelhouse listing ID when `channel` is `wheelhouse`. |

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `channel` | string | yes | Channel name the listing is on (the `channel` field of the [/listings](https://docs.usewheelhouse.com/rm/reference/rm-get-listings.md) response), or the literal `wheelhouse` to read `listing_id` as a Wheelhouse listing ID instead. See [Identifying Listings](https://docs.usewheelhouse.com/rm/concepts/listings.md). |
| `basis` | string | no | Return today's values (`current`) or the values as they stood at the same time last year (`stly`). See the description above for what `stly` returns. (one of: `current`, `stly`, default: `current`) |

### Example request

```bash
curl -X GET 'https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/kpis?channel=<channel>' \
  -H 'X-Integration-Api-Key: <your RM API key>'
```

Only required parameters and body fields are filled in, with placeholder values. Add the optional ones you need from the lists above; some are required in combination, as their descriptions say.

## Responses

### 200

Rolling-window KPIs.

Body (`application/json`): object `listing_kpis_response`

Rolling-window KPIs for a listing.

- `currency` (string, example: `USD`): ISO-4217 currency code for all monetary values in this response.
- `model_date` (string (date), nullable): Date the rolling-window stats were last computed. Null when no stat data exists.
- `adr` (object `kpi_rolling_window_bidirectional`, nullable): Average Daily Rate per period: average price of booked nights, excluding fees.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `adr_fees` (object `kpi_rolling_window_bidirectional`, nullable): Average Daily Rate (+ Fees) per period: average price of booked nights, including fees.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `asking_rate` (object `kpi_rolling_window_bidirectional`, nullable): Asking Rate (Booked + Available Nights) per period: average nightly price across booked and available nights, excluding fees. A booked night counts at the rate it was booked for, an available night at its current price. Blocked nights are left out. `null` when no night qualifies. See `asking_rate_available` for available nights only.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `asking_rate_available` (object `kpi_rolling_window_bidirectional`, nullable): Asking Rate (Available Nights) per period: sum of nightly prices on available nights / number of available nights, excluding fees. Booked and blocked nights, and nights without a price, count in neither. `null`, not `0`, when no available night has a price.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `asking_rate_fees` (object `kpi_rolling_window_bidirectional`, nullable): Asking Rate (+ Estimated Fees) per period: current average price of bookable nights, including estimated fees derived from past reservations.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `asking_rate_highest` (object `kpi_rolling_window_bidirectional`, nullable): Highest asking rate within the period.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `asking_rate_lowest` (object `kpi_rolling_window_bidirectional`, nullable): Lowest asking rate within the period.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `bookings` (object `kpi_rolling_window_bidirectional`, nullable): Number of reservations (booking count, not night count) whose stay dates fall within the period. Corresponds to the 'Bookings' metric in the Wheelhouse platform. Available in both past (`'N_0'`) and future (`'0_N'`) period windows.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `comp_set_count` (integer, nullable): Number of listings in the listing's default comp set.
- `comp_set_occupancy` (object `kpi_rolling_window_comp_set`, nullable): Comp-set occupancy rate (booked / calendar nights) per forward-looking period (7, 30, 60 days).

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_30`, `0_60`.
  - Fields: see `kpi_rolling_window_comp_set` under Schemas.
- `comp_set_occupancy_adjusted` (object `kpi_rolling_window_comp_set`, nullable): Comp-set open occupancy rate (booked / bookable nights) per forward-looking period (7, 30, 60 days).

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_30`, `0_60`.
  - Fields: see `kpi_rolling_window_comp_set` under Schemas.
- `comp_set_revenue` (object `kpi_rolling_window_comp_set`, nullable): Comp-set average revenue per listing per forward-looking period (7, 30, 60 days).

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_30`, `0_60`.
  - Fields: see `kpi_rolling_window_comp_set` under Schemas.
- `last_booked_days` (object `kpi_rolling_window_bidirectional`, nullable): Last Booked (Days) per period: number of days since the most recent booking whose stay dates overlap the period. Null when no booking affects the period.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `lead_time` (object `kpi_rolling_window_bidirectional`, nullable): Lead Time (Average) per period: average number of days before the stay date that bookings occurred.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `length_of_stay` (object `kpi_rolling_window_bidirectional`, nullable): Length of Stay (Average) per period: average number of nights booked per reservation.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `min_price_occurrence` (object `kpi_rolling_window_bidirectional`, nullable): Minimum Price Occurrence per period: number of days (regardless of booking status) where the observed price is equal to, or less than, the listing's minimum price.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `nights_available` (object `kpi_rolling_window_bidirectional`, nullable): Nights (Available) per period: number of nights currently available within the period.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `nights_blocked` (object `kpi_rolling_window_bidirectional`, nullable): Nights (Blocked) per period: number of nights currently blocked within the period.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `nights_bookable` (object `kpi_rolling_window_bidirectional`, nullable): Nights (Bookable) per period: available plus booked nights, excluding blocked nights.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `nights_booked` (object `kpi_rolling_window_bidirectional`, nullable): Nights (Booked) per period: number of nights currently booked within the period.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `nights_calendar` (object `kpi_rolling_window_bidirectional`, nullable): Nights (Calendar) per period: number of nights in the period, irrespective of listing status.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `nights_percent_open` (object `kpi_rolling_window_bidirectional`, nullable): Nights (Bookable %) per period: percentage of Nights (Bookable) within Nights (Calendar).

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `occupancy` (object `kpi_rolling_window_bidirectional`, nullable): Occupancy rate per period (booked nights / calendar nights).

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `occupancy_adjusted` (object `kpi_rolling_window_bidirectional`, nullable): Open occupancy rate per period (booked nights / bookable nights).

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `occupancy_neighborhood` (object `kpi_rolling_window_forward_only`, nullable): Occupancy (Neighborhood) per forward-looking period: occupancy rate of the listing's local neighborhood cluster (comparable nearby properties).

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`,
  `0_60`, `0_90`, `0_180`, `0_365`.
  - Fields: see `kpi_rolling_window_forward_only` under Schemas.
- `occupancy_neighborhood_adjusted` (object `kpi_rolling_window_forward_only`, nullable): Open occupancy rate (booked / bookable) of the listing's neighborhood cluster per forward-looking period.

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`,
  `0_60`, `0_90`, `0_180`, `0_365`.
  - Fields: see `kpi_rolling_window_forward_only` under Schemas.
- `occupancy_neighborhood_adjusted_pp` (object `kpi_rolling_window_forward_only`, nullable): Percentage-point difference between the listing's open occupancy and the neighborhood cluster open occupancy per forward-looking period.

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`,
  `0_60`, `0_90`, `0_180`, `0_365`.
  - Fields: see `kpi_rolling_window_forward_only` under Schemas.
- `occupancy_neighborhood_adjusted_ratio` (object `kpi_rolling_window_forward_only`, nullable): Ratio of the listing's open occupancy to the neighborhood cluster open occupancy per forward-looking period.

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`,
  `0_60`, `0_90`, `0_180`, `0_365`.
  - Fields: see `kpi_rolling_window_forward_only` under Schemas.
- `occupancy_neighborhood_pp` (object `kpi_rolling_window_forward_only`, nullable): Percentage-point difference between the listing's occupancy and the neighborhood cluster occupancy per forward-looking period (listing − cluster, expressed in percentage points).

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`,
  `0_60`, `0_90`, `0_180`, `0_365`.
  - Fields: see `kpi_rolling_window_forward_only` under Schemas.
- `occupancy_neighborhood_ratio` (object `kpi_rolling_window_forward_only`, nullable): Ratio of the listing's occupancy to the neighborhood cluster occupancy per forward-looking period (listing / cluster).

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`,
  `0_60`, `0_90`, `0_180`, `0_365`.
  - Fields: see `kpi_rolling_window_forward_only` under Schemas.
- `pickup` (object `kpi_rolling_window_trailing_only`, nullable): Pickup (Booked Nights) per backward-looking period: number of new nights booked within the past N days (by booking creation date, not stay date).

  Backward-looking keys only (`N_0` = past N days): `7_0`, `14_0`, `21_0`, `30_0`,
  `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_trailing_only` under Schemas.
- `pickup_bookings` (object `kpi_rolling_window_trailing_only`, nullable): Pickup (Bookings) per backward-looking period: number of distinct bookings picked up within the past N days (one per reservation, by booking creation date).

  Backward-looking keys only (`N_0` = past N days): `7_0`, `14_0`, `21_0`, `30_0`,
  `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_trailing_only` under Schemas.
- `revenue` (object `kpi_rolling_window_bidirectional`, nullable): Revenue per period: sum of prices (rent only) for booked nights.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `revenue_available` (object `kpi_rolling_window_bidirectional`, nullable): Revenue (Available) per period: sum of the current asking rates for available nights.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `revenue_blocked` (object `kpi_rolling_window_bidirectional`, nullable): Revenue (Blocked) per period: sum of the current asking rates for blocked nights (opportunity cost of blocked nights).

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `revenue_fees` (object `kpi_rolling_window_bidirectional`, nullable): Revenue (+ Fees) per period: sum of prices (rent plus fees) for booked nights.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `revenue_fees_taxes` (object `kpi_rolling_window_bidirectional`, nullable): Revenue (+ Fees, Taxes) per period: sum of prices (rent plus fees plus taxes) for booked nights.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `revenue_score` (object `kpi_rolling_window_forward_only`, nullable): Revenue Score per cumulative forward-looking period (next 7 through next 365
  days). Scores are on a 0–100 scale; higher values indicate the listing is
  capturing more of its expected revenue and outperforming its market segment.
  Null for periods beyond the listing's recommendation horizon.

  Forward-looking keys only (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`,
  `0_60`, `0_90`, `0_180`, `0_365`.
  - Fields: see `kpi_rolling_window_forward_only` under Schemas.
- `revpar` (object `kpi_rolling_window_bidirectional`, nullable): Revenue per available room night per period.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `revpar_adjusted_occupancy` (object `kpi_rolling_window_bidirectional`, nullable): RevPAR excluding blocked nights per period. Canonical name: 'RevPAR (Adjusted Occupancy)'. Previously called 'Adjusted Nightly RevPAR' in the Wheelhouse platform.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `revpar_adjusted_occupancy_fees` (object `kpi_rolling_window_bidirectional`, nullable): RevPAR including fees, excluding blocked nights per period.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.
- `revpar_fees` (object `kpi_rolling_window_bidirectional`, nullable): RevPAR including fees per period.

  Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
  `0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
  `21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.
  - Fields: see `kpi_rolling_window_bidirectional` under Schemas.

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "currency": "USD",
  "model_date": "2026-01-01",
  "adr": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "adr_fees": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "asking_rate": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "asking_rate_available": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "asking_rate_fees": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "asking_rate_highest": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "asking_rate_lowest": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "bookings": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "comp_set_count": 0,
  "comp_set_occupancy": {
    "0_7": 0,
    "0_30": 0,
    "0_60": 0
  },
  "comp_set_occupancy_adjusted": {
    "0_7": 0,
    "0_30": 0,
    "0_60": 0
  },
  "comp_set_revenue": {
    "0_7": 0,
    "0_30": 0,
    "0_60": 0
  },
  "last_booked_days": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "lead_time": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "length_of_stay": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "min_price_occurrence": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "nights_available": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "nights_blocked": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "nights_bookable": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "nights_booked": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "nights_calendar": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "nights_percent_open": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "occupancy": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "occupancy_adjusted": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "occupancy_neighborhood": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0
  },
  "occupancy_neighborhood_adjusted": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0
  },
  "occupancy_neighborhood_adjusted_pp": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0
  },
  "occupancy_neighborhood_adjusted_ratio": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0
  },
  "occupancy_neighborhood_pp": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0
  },
  "occupancy_neighborhood_ratio": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0
  },
  "pickup": {
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "pickup_bookings": {
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "revenue": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "revenue_available": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "revenue_blocked": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "revenue_fees": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "revenue_fees_taxes": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "revenue_score": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0
  },
  "revpar": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "revpar_adjusted_occupancy": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "revpar_adjusted_occupancy_fees": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  },
  "revpar_fees": {
    "0_7": 0,
    "0_14": 0,
    "0_21": 0,
    "0_30": 0,
    "0_60": 0,
    "0_90": 0,
    "0_180": 0,
    "0_365": 0,
    "7_0": 0,
    "14_0": 0,
    "21_0": 0,
    "30_0": 0,
    "60_0": 0,
    "90_0": 0,
    "180_0": 0,
    "365_0": 0
  }
}
```

### 401

API key authorization failed.

### 403

Listing authorization failed, or `basis=stly` was requested by an account without early access to it.

### 404

Listing not found.

### 406

The listing is inactive. See the **Inactive Listings** section in the overview.

Body (`application/json`): object

- `error` (string, example: `Listing '12345' is inactive`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "Listing '12345' is inactive"
}
```

### 429

Rate limit exceeded — the API key has sent too many requests. Wait before retrying. See the **Rate Limits** section in the overview for the recommended exponential backoff strategy.

Body (`application/json`): object

- `error` (string, example: `API token is at rate limit`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "API token is at rate limit"
}
```

## Schemas

Shared by more than one field above.

### `kpi_rolling_window_bidirectional`

Type: object `kpi_rolling_window_bidirectional`

Forward-looking keys (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`, `0_60`,
`0_90`, `0_180`, `0_365`. Backward-looking keys (`N_0` = past N days): `7_0`, `14_0`,
`21_0`, `30_0`, `60_0`, `90_0`, `180_0`, `365_0`.

- `0_7` (number, nullable): Next 7 days.
- `0_14` (number, nullable): Next 14 days.
- `0_21` (number, nullable): Next 21 days.
- `0_30` (number, nullable): Next 30 days.
- `0_60` (number, nullable): Next 60 days.
- `0_90` (number, nullable): Next 90 days.
- `0_180` (number, nullable): Next 180 days.
- `0_365` (number, nullable): Next 365 days.
- `7_0` (number, nullable): Past 7 days.
- `14_0` (number, nullable): Past 14 days.
- `21_0` (number, nullable): Past 21 days.
- `30_0` (number, nullable): Past 30 days.
- `60_0` (number, nullable): Past 60 days.
- `90_0` (number, nullable): Past 90 days.
- `180_0` (number, nullable): Past 180 days.
- `365_0` (number, nullable): Past 365 days.

### `kpi_rolling_window_comp_set`

Type: object `kpi_rolling_window_comp_set`

Forward-looking keys only (`0_N` = next N days): `0_7`, `0_30`, `0_60`.

- `0_7` (number, nullable): Next 7 days.
- `0_30` (number, nullable): Next 30 days.
- `0_60` (number, nullable): Next 60 days.

### `kpi_rolling_window_forward_only`

Type: object `kpi_rolling_window_forward_only`

Forward-looking keys only (`0_N` = next N days): `0_7`, `0_14`, `0_21`, `0_30`,
`0_60`, `0_90`, `0_180`, `0_365`.

- `0_7` (number, nullable): Next 7 days.
- `0_14` (number, nullable): Next 14 days.
- `0_21` (number, nullable): Next 21 days.
- `0_30` (number, nullable): Next 30 days.
- `0_60` (number, nullable): Next 60 days.
- `0_90` (number, nullable): Next 90 days.
- `0_180` (number, nullable): Next 180 days.
- `0_365` (number, nullable): Next 365 days.

### `kpi_rolling_window_trailing_only`

Type: object `kpi_rolling_window_trailing_only`

Backward-looking keys only (`N_0` = past N days): `7_0`, `14_0`, `21_0`, `30_0`,
`60_0`, `90_0`, `180_0`, `365_0`.

- `7_0` (number, nullable): Past 7 days.
- `14_0` (number, nullable): Past 14 days.
- `21_0` (number, nullable): Past 21 days.
- `30_0` (number, nullable): Past 30 days.
- `60_0` (number, nullable): Past 60 days.
- `90_0` (number, nullable): Past 90 days.
- `180_0` (number, nullable): Past 180 days.
- `365_0` (number, nullable): Past 365 days.
