Skip to main content
POST
Run a competitor collection now, for one competitor or for all of them. Collection normally runs on its own: every two weeks for each competitor, at your workspace’s weekly slot (the schedule), and once when a competitor is added. Use this to collect again in between.
  • A competitor that is already being collected keeps its current run.
  • A run collects the activity since the competitor’s previous run, or the last 90 days the first time.
  • When a competitor’s next scheduled collection is less than ten days away, this run takes its place.
  • Runs are limited per workspace: a run started too soon after the previous one answers 429 with code RATE_LIMITED, and you can try again a little later.
Poll List Competitor Runs to follow the runs it started.

MCP

The same action is the run_competitor_monitoring tool, with the same competitor_id argument and the same throttle.

Authorizations

Authorization
string
header
required

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

Body

application/json
competitor_id
string

One competitor, by its Clustr ID (cmp_…) from List Competitors. Omit it, or send no body, to run every competitor. The id from earlier responses also works.

Example:

"cmp_r0jpyyqyeh0txpgdhb604j2g9s"

Response

The run request is accepted

success
boolean
required
Example:

true

data
object
required