Get yearly stats for a listing.
GET/listings/:listing_id/kpis/yearly
Returns per-year performance stats, ordered oldest-to-newest.
Covers both past and future years — from 5 calendar years ago through the year containing
the maximum calendar horizon (1.5 years from now), subject to the years Wheelhouse holds data
for. That last year includes only the nights up to the horizon, so its nights and revenue
cover part of the year. The current year and any that follow are forward-looking: they
reflect the bookings on the books so far plus asking rates for nights that are still open,
so they are not final and will change as bookings come in. Compare a year's year value
against today's date to tell which side of the line it falls on.
Same time last year. Pass basis=stly to get each year as it stood at the same time
last year. The row under a year holds the year before, as it stood 52 weeks ago, so a
year that was still ahead then counts only the bookings on the books at the time. Rows
sit under the current year they compare with, so the two bases can be joined on
year. revenue_blocked is null. Years with no stats for last year are absent.
basis=stly is in early access; accounts without early access get a 403.
All monetary values are in the listing's currency.
Request
Responses
- 200
- 401
- 403
- 404
- 406
- 429
Yearly KPIs.
API key authorization failed.
Listing authorization failed, or basis=stly was requested by an account without early access to it.
Listing not found.
The listing is inactive. See the Inactive Listings section in the overview.
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.