> ## Documentation Index > Fetch the complete documentation index at: https://docs.casa-layer.com/llms.txt > Use this file to discover all available pages before exploring further. # Reviews summary > Aggregates review statistics for the credential's scope: totals, average rating, rating distribution, per-channel breakdown, host-response count, and the most frequent positive/negative tags. Accepts the same filters as review search (minus `q`), so the aggregate can be windowed by review date, bounded by rating, or narrowed to one channel. Requires scope `read:reviews`. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/reviews/summary openapi: 3.1.0 info: title: Casa API version: 1.0.0 description: > Headless, read-only access to the guest context layer — the entire canonical data model over HTTP. Every endpoint is **scoped by the credential**: the default scope is the caller's property group, returning data across all of its properties. Auth sources resolve to the same credential: a user-generated **API key** (`casa_…`, created in Account settings — the recommended method for machines), a WorkOS AuthKit session JWT (the web app; org and role come from verified token claims), or a static token. (The MCP server also accepts read-only OAuth connector tokens, but those are rejected on these REST routes.) Send `X-Property-Id` to drill down into a single property; API keys can also be pinned to one property at creation. Tenant isolation holds by construction. Integration-management endpoints write connection *metadata* only and are session-only; canonical guest data enters exclusively through the connector workers and the ingest pipeline. The Model Context Protocol (MCP) server is exposed separately at `/mcp` and is documented under **MCP Server** in the guides — it is not a REST endpoint and is intentionally omitted from this reference. It accepts the same API keys. servers: - url: https://api.casa-layer.com description: Production Cloudflare Worker security: - bearerAuth: [] tags: - name: System description: Liveness, health, and the public welcome page. - name: Guests description: Canonical guest profiles as ingested from each source system. - name: Master Profiles description: >- Identity-resolved golden records — one entity per real guest, merged across sources and properties. - name: Reservations description: >- Reservation records linked to guest profiles, searchable by status, stay window, and channel. - name: Transactions description: >- Revenue lines (Pace Transactions V2–shaped) linked to guests and optionally reservations. - name: Consents description: > Contact-grain consent observations (contact method + value × purpose). Rows store decisive signals only (granted/withdrawn/denied); absence of a row means unknown / not eligible. Effective eligibility within a property group is the most restrictive status among stored observations for the same contact×purpose (withdrawn/denied beat granted). - name: Tables description: > Attio-style ops tables — curated or filter-defined containers for day-to-day work inside Casa. Tables are not consent eligibility records and not marketing segments; campaign audiences stay in downstream ESP tools (Klaviyo, Mailchimp, and peers). - name: Actions description: Guest actions (purchases, visits, and other tracked events). - name: Events description: >- The append-only guest event log — full change history or latest delta slice per entity. - name: Reviews description: Guest reviews with free-text search and an aggregate summary. - name: Loyalty description: Loyalty programs and member search (tier, points, guest). - name: Dimensions description: Reference dimensions — booking channels and bookable spaces. - name: Properties description: >- Properties within a group, plus self-serve onboarding (org-anchored tenant bootstrap). - name: SQL description: >- Read-only SQL over the public data model, isolated per tenant by row-level security. - name: API Keys description: Manage the organization's API keys (session-only). - name: Integrations description: >- Connection metadata for source systems (Mews, Square, …). Metadata only — never canonical guest data. Session-only. paths: /v1/reviews/summary: get: tags: - Reviews summary: Reviews summary description: > Aggregates review statistics for the credential's scope: totals, average rating, rating distribution, per-channel breakdown, host-response count, and the most frequent positive/negative tags. Accepts the same filters as review search (minus `q`), so the aggregate can be windowed by review date, bounded by rating, or narrowed to one channel. Requires scope `read:reviews`. parameters: - name: start_date in: query schema: type: string format: date - name: end_date in: query schema: type: string format: date - name: channel in: query description: Channel name (e.g. Booking.com). schema: type: string - name: min_rating in: query schema: type: number - name: max_rating in: query schema: type: number - name: host_response in: query description: >- Only include reviews with (`true`) / without (`false`) a host response. schema: type: boolean - $ref: '#/components/parameters/PropertyHeader' responses: '200': description: Aggregate review statistics. content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/ReviewsSummary' example: data: total_reviews: 412 average_rating: 8.7 responded_count: 233 rating_distribution: - rating: 10 count: 141 - rating: 9 count: 132 - rating: 8 count: 84 by_channel: - channel_name: Booking.com count: 227 average_rating: 8.5 - channel_name: Google count: 111 average_rating: 9 top_positive_tags: - tag: service count: 187 - tag: location count: 122 top_negative_tags: - tag: noise count: 31 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' components: parameters: PropertyHeader: name: X-Property-Id in: header required: false description: > 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. schema: type: string format: uuid schemas: ReviewsSummary: type: object description: Aggregate review statistics for the requested scope and window. required: - total_reviews - average_rating - responded_count - rating_distribution - by_channel - top_positive_tags - top_negative_tags properties: total_reviews: type: integer average_rating: type: - number - 'null' responded_count: type: integer description: Reviews with a host response. rating_distribution: type: array items: type: object properties: rating: type: integer description: Rounded rating bucket. count: type: integer by_channel: type: array items: type: object properties: channel_name: type: - string - 'null' count: type: integer average_rating: type: - number - 'null' top_positive_tags: type: array items: type: object properties: tag: type: string count: type: integer top_negative_tags: type: array items: type: object properties: tag: type: string count: type: integer Error: type: object required: - error properties: error: type: string description: Machine-readable error code. scope: type: string description: The scope that was required when the error is a scope failure.: null detail: type: string description: Optional human-readable detail. responses: Unauthorized: description: Missing, unknown, or revoked bearer credential. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: unauthorized Forbidden: description: > The credential lacks the scope required for this endpoint, or the auth surface is wrong. Machine-readable codes include `forbidden` (scope or role), `tenant_not_provisioned` (org claim present but no property group), and `mcp_oauth_required` (SPA session token used on `/mcp`). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: forbidden scope: read:guests securitySchemes: bearerAuth: type: http scheme: bearer description: > `Authorization: Bearer `. 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. ````