Insights & exports

AI-driven insights report, a per-account Excel locations export, and the partner/account 'email report subscription' CRUD — the engine that drives the automated daily/weekly/monthly digest emails delivered to ops staff.

AI-driven insights report, a per-account Excel locations export, and the partner/account "email report subscription" CRUD — the engine that drives the automated daily/weekly/monthly digest emails delivered to ops staff.

Prerequisites

  • A bearer token in the Authorization header. 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

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
GETAI insights reportGet 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.
GETExport locations to ExcelGenerate an Excel export of all locations under the authenticated account, stores it to S3, and returns the public download URL.
POSTCreate partner email reportCreate 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.
POSTEdit partner email reportUpdate an existing partner email report's frequency and account targeting; report type and recipient are not changed here.
POSTAdd an account email report (per-user)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.
POSTEdit an account email reportUpdate an existing account email report's frequency and store assignments (recipient and report type unchanged).
DELETEDelete an account email reportDelete 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.
POSTEmail reports listReturns a paginated list of the authenticated user's company email reports (recipient + cadence + targeted stores/accounts), with optional sorting and single-field search.
DELETEEmail report deleteDelete an email report and all of its associated rows (recipients, store links, user links, account links) plus the report itself, inside a DB transaction.