Skip to main content
POST
Read a competitor’s website again now instead of waiting for the monthly refresh, for example right after you changed its website_url. The read runs in the background: Get Competitor Site shows it when it is done, and the customers it finds appear after the competitor’s next run. It needs an API key created by a workspace admin (403 ADMIN_REQUIRED otherwise), and runs at most once a day per site: within 24 hours of the last read the answer is 429 TOO_SOON.

Authorizations

Authorization
string
header
required

The API key you created on the API settings page of the Clustr app.

Path Parameters

id
string
required

The competitor's Clustr ID (cmp_…), from List Competitors. The id from earlier responses also works.

Response

The read started

success
boolean
required
Example:

true

data
object
required