Get monthly stats for a listing.
GET/listings/:listing_id/kpis/monthly
Returns per-month performance stats, ordered oldest-to-newest. Includes comp-set metrics.
Covers both past and future months — up to 15 months back and forward through the month
containing the maximum calendar horizon (1.5 years from today), subject to the months
Wheelhouse holds data for. That last month includes only the nights up to the horizon, so
its nights and revenue cover part of the month. Months from the current one onward 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
month's month 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 month as it stood at the same
time last year. The row under a month holds that month a year earlier, as it stood
52 weeks ago, so a month that was still ahead then counts only the bookings on the books
at the time. Rows sit under the current month they compare with, so the two bases can
be joined on month. revenue_blocked and the comp_set_* fields are null. Months
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
Monthly 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.