Skip to navigation
Tools

Diagnostics and KPIs

get_listing_performance_metrics

Returns raw performance KPIs for a listing: ADR, revenue, occupancy, RevPAR, and related metrics. Use this when you need specific numbers rather than recommendations.

Best for: Explicit metric questions, historical performance comparisons, reporting.

Example: “What was the occupancy for Sunset Villa last month?”

Parameters

ParameterTypeRequiredDescription
listing_idstringYesUnique listing ID (resolve via get_listings first).
pms_namestringYesPMS name the listing belongs to.
questionstringYesVerbatim user text for this request (exactly as typed).

Response format

The response contains three sections inside data:

SectionDescription
metrics_summaryPre-formatted display values keyed by metric_name:dfd (e.g. "occupancy:7"). Each entry has value, and optionally vs_market or vs_stly (Same Time Last Year).
listing_levelRaw numerical listing metrics. DFD (Days From Date)-keyed objects for occupancy, revenue, ADR, RevPAR, adjusted_occupancy, min_prices (Days at Minimum Price), and their STLY variants. Scalars for bp_ratio and last_booked_date.
market_levelRaw market comparison data (occupancy, adjusted_occupancy, adr) keyed by DFD.

DFD (Days From Date) keys are strings representing days relative to the date the metrics were last calculated. For regular keys, negative = the past N days and positive = the next N days. Special keys are fixed calendar periods and their sign does not mean past or future: -999 (year to date), -998 (previous month), -997 (current month), 998 (next month), -995 (current quarter), 995 (next quarter). See Get Listing Performance Metrics for details.

If values are mostly -, metrics may not be synced yet for this listing.