post
https://production-api.shoutaboutus.com/api/v1/account/insight-report/generate
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_idscoped by an ownership check.
Rate limit
- No rate limit.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
store_id | integer | Required | Must 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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
