Skip to navigation

Get listing performance metrics

Returns numerical KPI data for a single listing, including listing-level metrics and market-level comparison data. Metrics include occupancy, revenue, ADR, RevPAR, adjusted occupancy, base price ratio, min prices (Days at Minimum Price), and last booked date.

Response Structure:

  • listing_level: Raw metric values from the listing’s own historical data. DFD (Days From Date, i.e. days relative to today)-based metrics have nested objects keyed by DFD string. Non-DFD metrics (bp_ratio, last_booked_date) are scalar values. STLY (Same Time Last Year) comparisons are stored as stly_<metric_name> keys.
  • market_level: Raw market comparison values from portfolio/market engine data. Only includes metrics with market comparison (occupancy, adjusted_occupancy, adr).

Useful Comparisons:

  • Listing vs Market: Compare listing_level[metric][dfd] with market_level[metric][dfd] at the same DFD (Days From Date) for occupancy/ADR to gauge pricing position.
  • Listing vs STLY: Compare listing_level.revenue[dfd] with listing_level.stly_revenue[dfd] for year-over-year growth.
  • bp_ratio: > 1 means priced above recommendation, < 1 means below.
  • min_prices: Percentage of days at minimum price per future window. High values suggest a base price review.

DFD (Days From Date) Keys:

Keys are strings. Metrics are calculated and stored per listing, so all windows are relative to the date the metrics were last calculated, not the time of the API request.

Regular keys count days: negative = the past N days, positive = the next N days (e.g. -30, 7, 90). Default set: -90, -60, -45, -30, -21, -15, -7, 1, 2, 3, 7, 10, 15, 21, 30, 45, 60, 90, 120, 180, 240, 300, 360. min_prices uses only 7, 15, 21, 30, 45, 60, 90.

Special keys are fixed calendar periods. Their sign does not mean past or future:

KeyPeriodDate range
-999Year to date1 January of the current year up to the calculation date
-998Previous monthThe full previous calendar month
-997Current monthThe full current calendar month, 1st to last day (includes upcoming dates)
998Next monthThe full next calendar month
-995Current quarterThe full current calendar quarter (includes upcoming dates)
995Next quarterThe full next calendar quarter

-995 and 995 appear on occupancy, revenue, adr, revpar and the goal_completion_* metrics. stly_* metrics use -999, -998, -997 and 998 for the equivalent period last year.

Headers

X-API-KeystringRequired
API key for Customer API authentication.

Query parameters

listing_idstringRequired

Unique listing ID (same as PriceLabs dashboard).

pms_namestringRequired
PMS name the listing belongs to.

Response

Performance metrics retrieved successfully.
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error