Generate previous month's insight 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). Always targets last month. If a non-failed report for that month already exists it comes back unchanged (no regeneration). Otherwise it behaves like the submit endpoint — queues an async ReviewData run and bills 1 unit against the store's insight_report quota. The store must have enough recent reviews.

Auth

  • Bearer account / partner token. store_id scoped by an ownership check.

Rate limit

  • No rate limit.

Body

FieldTypeRequiredNotes
store_idintegerRequiredMust be an existing location, in caller's hierarchy. Must have >= the minimum recent reviews and >= 1 linked review site with a configured publisher. Year/month are forced to last month; The endpoint ignores other body fields on this route.

Behaviour

  • 202 — fresh report queued ({ data: {. Status: 'queued', task_id } }). Poll Check status (poll until complete) for the result.
  • 200 — an existing non-failed report for the month comes back as-is (deduped).
  • Emits X-Feature-* usage headers.
  • 403 — quota exceeded (hard-stop) / feature disabled.
  • 422 — not enough recent reviews, or store has no publisher-linked review site.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json