Polls the current status of a previously-queued competitive report, read straight from our database (the completed report lands via the COMPETITIVE_REPORT_RESULT webhook). Pure read — never calls ReviewData and never counts usage.
Auth: Both — authentication (route sits directly under the authenticated group, not behind partner-only access). The store must sit inside your own account tree, keyed on store_id, and report_id must Must be an existing competitive report. The service loads the row scoped to that store, so a Partner can poll any store in its tree while an Account reaches only its own.
Rate limit: No rate limit.
Request
- Body (success wrapped as
{ data. }, HTTP 200):
| Field | Type | Required | Notes |
|---|---|---|---|
store_id | integer | yes | Must be an existing location inside your own account tree. |
report_id | integer | yes | Must be an existing competitive report; the competitive_report_id from Submit competitive report (generate) / List stored competitive reports. |
Response — { data. } envelope (HTTP 200), the full present shape (same fields as Submit competitive report (generate)'s data, minus remaining/overage).
competitive_report_id(integer)store_id(integer)review_site_id(integer|null)publisher(string)year(integer)month(integer|null)theme(string)status(string) — e.g.queued,processing,succeeded,failed.task_id(string|null)competitors(array)competitor_count(integer)review_count(integer|null)report_data(object|null) — populated once the webhook completes the report.failure_reason(string|null)failure_details(mixed|null)completed_at(string|null, ISO 8601)
Errors: 422 on validation failure.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
