Start generating a report for a location over a period. Use this when you want a fresh report. Optionally pick a review site, a period (year, and month for a single month) and a theme; with no year, the report covers the previous calendar month. Returns a report id to poll with Check report status. Counts against your allowance. If a report for the same location, review site, period and theme already exists (and hasn't failed), that report is returned instead (200, deduped: true) and nothing is counted. To generate again anyway, send force: true (see Regenerate a report).
Prerequisites: a bearer token and the location's id (store_id). The location needs at least 10 reviews in the last 48 months, and at least one linked review site that reports can use. Insight reports must be on the location's plan.
Authentication: Partner or Account token. store_id must be inside your own account tree (a Partner token reaches any location under the partner, an Account token only its own); otherwise 422.
Rate limit: 60 requests per minute, counted per user (the token’s user).
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
