An AI-written report on what a business's reviews say: themes, praise, complaints, and suggestions.
An AI-written report on what a business's reviews say: themes, praise, complaints, and suggestions.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | Generate an insight report | Queue an async insight report for one store + publisher and counts 1 unit against the store's insight_report plan quota at submit time. |
POST | Check report status | Returns the current state of a previously-queued insight report, read entirely from our stored report record by id scoped to the store. |
POST | Get the latest report | Returns the most recent stored insight report for a target identity (store + review site + period + theme), read entirely from our database — it never calls an external service and never consumes usage. |
GET | AI insights summary | Get the AI-insights report envelope for a single store: a live per-platform performance breakdown computed from the latest 30 non-suppressed, on-platform reviews within a 6-month window, plus stubbed narrative fields (summary, key_insights) reserved for a later AI-generation work-stream. |
POST | Generate last month's report | Backs the UI 'Generate report' button, shown only for the PREVIOUS calendar month when the scheduled run produced no report (it failed, or the location was onboarded mid-month). |