Skip to main content
GET
Reviews summary

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Token types resolve to the same scoped credential: a user-generated API key (casa_…, from Account settings — recommended for machines and MCP clients), a WorkOS AuthKit session JWT (the web app; org and role come from verified token claims), or a static token. API keys are group-scoped, optionally pinned to one property at creation. MCP OAuth connector tokens authenticate the MCP server only and are rejected on these REST routes.

Headers

X-Property-Id
string<uuid>

Optional single-property drill-down. When set, narrows the request to this property; it must belong to the caller's group, else 403. A property-pinned API key is already narrowed and ignores this header.

Query Parameters

start_date
string<date>
end_date
string<date>
channel
string

Channel name (e.g. Booking.com).

min_rating
number
max_rating
number
host_response
boolean

Only include reviews with (true) / without (false) a host response.

Response

Aggregate review statistics.

data
object
required

Aggregate review statistics for the requested scope and window.