List past reports

Get the competitive reports already generated for a location. Use this to display history. Returns the reports, newest first, with a summary across all the location's reports. Each row leaves out the report itself; open one with Check report status.

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.

string | null
Defaults to failed

Filter by status, at most 32 characters. queued matches queued and pending reports; in_progress matches waiting_for_scrape, processing and running; succeeded matches succeeded, success, complete and completed; failed matches failed and error. Any other value matches that status exactly.

string | null
Defaults to maps.google.com

Filter by the review site's source. At most 64 characters; exact match.

string | null
Defaults to home-services

Filter by theme. At most 64 characters; exact match.

string | null
Defaults to competitor_48

Find one report by its foreign_key (competitor_{id}) or bare id. At most 64 characters. A value that isn't a number after the prefix matches nothing.

integer | null
10 to 100
Defaults to 50

Reports per page, 10 to 100 (values below 10 are raised to 10; above 100 returns 422). Defaults to 50.

integer | null
≥ 1
Defaults to 1

The page, from 1. Defaults to 1.

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