Start a comparison of a location against one or two competitors on a site. Use this when a business wants to see how it stacks up. You'll need the store_id, the review_site_id, the year, and one or two competitors (each a name and a profile URL on that review site). theme and month are optional. Returns a report id to poll with Check report status. Billed on submit; counts against your allowance. If a report for the same location, review site, period, theme and competitors already exists (and hasn't failed), that report is returned instead (200, deduped: true) and nothing is billed; send force: true to generate a new one.
Prerequisites: a bearer token, the location's id (store_id), and a review site linked to the location with its review-site URL set (review_site_id). Competitive analysis must be on the location's plan.
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).
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
