An AI-written summary of what your reviews are saying, a locations export, and scheduled email reports.
An AI-written summary of what your reviews are saying, a locations export, and scheduled email reports.
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 |
|---|---|---|
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. |
GET | Export locations to Excel | Generate an Excel export of all locations under the authenticated account, stores it to S3, and returns the public download URL. |
POST | Schedule a partner email report | Create a scheduled partner-level email report (activity/response/feed/etc.) for a recipient, scoped to all accounts the partner owns or to a specific list of account companies. |
POST | Edit a partner email report | Update an existing partner email report's frequency and account targeting; report type and recipient are not changed here. |
POST | Schedule an account email report | Add a new recipient to receive an automated account-level email report on a daily/weekly/monthly cadence, scoped to all stores under the account or a specific store list. |
POST | Edit an account email report | Update an existing account email report's frequency and store assignments (recipient and report type unchanged). |
DELETE | Delete an account email report | Delete an account email report and all of its associated rows (recipients, store links, user links, account links) plus the report itself, inside a DB transaction. |
POST | List scheduled reports | Returns a paginated list of the authenticated user's company email reports (recipient + cadence + targeted stores/accounts), with optional sorting and single-field search. |
DELETE | Delete a scheduled report | Delete an email report and all of its associated rows (recipients, store links, user links, account links) plus the report itself, inside a DB transaction. |