Insight Report
Endpoints in the Insight Report area.
Endpoints in the Insight Report area.
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
POST — Queue an async ReviewData insight report for one store + publisher and counts 1 unit against the store's insight_report plan quota at submit time.
POST — Force-regenerates an insight report for a store + publisher. It bypasses the dedup guard, so a fresh ReviewData run is started and billed even when a non-failed report already exists for the same store, review site, period, and theme.
POST — Returns the current state of a previously-queued insight report, read entirely from our stored report record by id scoped to the store.
POST — Returns the most recent stored insight report for a target identity (store + review site + period + theme), read entirely from our database — it never calls ReviewData and never consumes usage.
GET — Get the AI-insights report for a single store: a live per-platform performance breakdown from the latest 30 published reviews within a 6-month window, plus placeholder summary and key_insights fields reserved for a future AI-generated summary.
POST — 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).
Updated 14 days ago