Get the latest report

Fetch the most recent insight report for a location and period, in any state (pending, queued, processing, complete or failed). Check status before showing it. Optionally narrow it with review_site_id, year, month and theme. Returns the report, or {"found": false} when there isn't one yet.

Prerequisites: a bearer token and the location's id (store_id).

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. Must exist and be inside your account tree.

integer | null
Defaults to 44

The review site. Must exist and be linked to the location. Leave it out to match the combined report across all the location's review sites.

integer | null
2000 to 2100
Defaults to 2026

The report year, 2000 to 2100. Leave it out to match the previous calendar month's report (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, it matches the full-year report.

string | null
Defaults to home-services

The report theme, at most 64 characters. Leave it out to match the most recent report for the period whatever its theme.

boolean | null
Defaults to false

Accepted but not used here.

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