---
title: "List Insights"
method: GET
path: "/api/insights"
tags: ["Insights"]
---

# List Insights

`GET /api/insights`

## Request

- Base URL: `https://data.getplace.io` (the document declares no server; this is the origin it was published from)
- URL: `https://data.getplace.io/api/insights`
- Auth: OAuth 2
  - Password
  - Token URL: `/api/auth/login`

List generated insights. Requires authentication.

## Query parameters

- `city_id` integer, nullable
- `chain_id` integer, nullable
- `limit` integer

## Response `200`

Successful Response

- InsightResponse[]
  - `id` string, uuid, required
  - `city_id` integer, required
  - `chain` string, nullable, required
  - `period_start` string, date, required
  - `period_end` string, date, required
  - `summary` string, nullable, required
  - `insights_data` unknown[], nullable, required
    - unknown
  - `reviews_analyzed` integer, required
  - `generated_at` string, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getplace/apis/getplace-insights-api.md) - [All operations](https://skmtc.dev/getplace/apis/getplace-insights-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getplace/apis/getplace-insights-api/revisions/0f337387603f?raw)