AI insight report
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, generated on demand or monthly.
Generating a report takes a minute or two. Start it, poll for completion, then fetch it. Each report counts against your plan's insight-report allowance.
You'll need an account token and the store_id or account.
Scheduled email reports are set up through separate endpoints: Schedule an account email report (daily, weekly or monthly, depending on the report), Schedule a partner email report, and List scheduled reports to manage them. To build reporting into your own product instead, use the KPI and report endpoints, such as Headline numbers.
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 — Start generating a report for a location or account over a period.
GET — A quick AI-written summary of themes, praise, and complaints, scoped to the account.
Updated 17 days ago