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 Authorization header. 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

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

List comparison themes

POST — Get the themes a report can compare on: service, price, quality, and so on.

Open →

Generate a competitive report

POST — Start a comparison of a location against one or two competitors on a site.

Open →

Check report status

POST — See whether a report is ready.

Open →

List past reports

POST — Get the competitive reports already generated for a location.

Open →


Did this page help you?