Generate an insight report

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

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.

integer | null
Defaults to 44

One review site to report on. Must exist and be linked to the location. Leave it out for a combined report across all the location's review sites (publisher is all).

integer | null
2000 to 2100
Defaults to 2026

The report year, 2000 to 2100. Leave it out for a report on the previous calendar month (any month you send is then ignored).

integer | null
1 to 12
Defaults to 8

The report month, 1 to 12. Used only with year; with year and no month, the report covers the whole year.

string | null
Defaults to home-services

The report theme, at most 64 characters. Leave it out to use the account's industry, or general when no industry is set.

boolean | null
Defaults to false

true generates a new report even when one already exists for the same location, review site, period and theme; the new report counts against your allowance. Defaults to false.

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