List stored competitive reports

List every competitive report stored for one store location, newest first (paginated), so the account can re-open a past report (use each row's competitive_report_id with Check status (poll until complete) to fetch the full payload). DB-only read — never calls ReviewData and never counts usage. Optional status/publisher/theme/foreign_key filters narrow the list; summary carries store-wide status counts and the total reviews scored for the page header.

Auth: Both — authentication (directly under the authenticated group, not behind partner-only access). The store must sit inside your own account tree, keyed on store_id. Reports cover only that one store, so a Partner can list any store in its tree, an Account only its own.

Rate limit: No rate limit.

Request

  • Body (success wrapped as { data. }, HTTP 200):
FieldTypeRequiredNotes
store_idintegeryesMust be an existing location inside your own account tree.
statusstringnomax:32. Listing chip; mapped to raw DB statuses (queued, then queued/pending, in_progress, then waiting_for_scrape/processing/running, succeeded, then succeeded/success/complete/completed, failed, then failed/error).
publisherstringnomax:64. Exact match.
themestringnomax:64. Exact match.
foreign_keystringnomax:64. Accepts competitor_{id} or a bare id; non-numeric matches nothing.
per_pageintegerno10–100 (values below 10 are raised to 10); defaults to 50.
pageintegernomin:1; defaults to 1.

Response{ data. } envelope (HTTP 200) with reports, summary, meta. Each reports[] row is the lightweight presentRow (heavy report_data omitted — fetch via Check status (poll until complete)).

  • reports[] (array of objects):
  • competitive_report_id (integer)
  • foreign_key (string) — competitor_{id}.
  • store_id (integer)
  • business (string|null) — store saucode.
  • business_name (string|null) — store name.
  • review_site_id (integer|null)
  • publisher (string)
  • year (integer)
  • month (integer|null)
  • theme (string)
  • status (string) — raw DB status.
  • competitor_count (integer)
  • competitors (array of string) — competitor names only.
  • review_count (integer|null)
  • owner_email (string|null) — requesting user email.
  • requested_by_user_id (integer|null)
  • created_at (string|null, ISO 8601)
  • completed_at (string|null, ISO 8601)
  • summary (object):
  • status_counts (object) — map of raw status → count, across ALL the store's reports.
  • reviews_scored (integer) — sum of review_count across all the store's reports.
  • total (integer) — total report count for the store.
  • meta (object): current_page, last_page, per_page, total (all integers).

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
string
string
string
integer
integer
Response

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