Competitive report
Compare a location's reviews against one or two competitors on the same review site.
Compare a location's reviews against one or two competitors on the same review site: rating, volume, themes, and where you win or lose.
You name the competitors; we collect their public reviews on that site and build the comparison. Reports take a few minutes. Each one counts against your plan's competitive-report allowance and is billed when you submit it.
You'll need an account token, the store_id, the review site, and the competitors' pages on that site.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
POST — Get the themes a report can compare on: service, price, quality, and so on.
POST — Start a comparison of a location against one or two competitors on a site.
Updated 26 days ago
