Generate last month's report

Generate a report covering the previous calendar month. Use this on a schedule for a monthly digest. The report is the combined report across all the location's review sites, with the theme from the account's industry. If a report for last month already exists (and hasn't failed), it's returned unchanged (200, deduped: true) and nothing is counted; otherwise a new one is generated and counts against your allowance. Returns a report id to poll with Check report status. Other fields of Generate an insight report are checked if you send them, but not used.

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).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 3007

The location to report on. Must exist and be inside your account tree, have at least 10 reviews in the last 48 months, and have at least one linked review site that reports can use.

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