Generate a competitive report

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).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 3007

The location to compare. Must exist and be inside your account tree.

integer
required
Defaults to 44

The review site to compare on. Must exist and be linked to the location, and the location needs its review-site URL for that site.

integer
required
2000 to 2100
Defaults to 2026

The report year, 2000 to 2100.

integer | null
1 to 12
Defaults to 9

The report month, 1 to 12. Leave it out for a full-year report.

string | null
Defaults to home-services

A theme slug from List comparison themes. At most 64 characters. Leave it out to use the account's industry (with the system default as the final fallback); general is no longer accepted by the reporting engine.

competitors
array of objects
required
length between 1 and 2

One or two competitors. Your plan may allow only one.

competitors*
string
required
length ≤ 255

The competitor's name. At most 255 characters.

uri
required
length ≤ 1024

At most 1,024 characters. The competitor's own business profile (review) page on the same review site as review_site_id, in the same form as your location's own review-site URL for that site. Only the URL format is checked here; the report provider then checks the competitor and can reject the request with 502 (rd_error_code: VALIDATION_ERROR). Confirm the accepted URL form for each review site with your account manager. Each competitor needs a different URL.

string | null

Your id for the competitor. At most 255 characters. Leave it out to have one made from profile_key.

string | null

At most 64 characters.

string | null

At most 2,048 characters.

tags
array of strings | null

At most 30 tags, each at most 64 characters.

tags
address
object | null

The competitor's address. All fields optional.

boolean | null
Defaults to false

true generates a new report even when one already exists for the same location, review site, period, theme and competitors; it's billed again. Defaults to false.

Responses

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