Skip to main content

​
Lifecycle

A run is queued, then running, until it ends. A run that worked ends succeeded. Any other end status means it did not, and error says why. While it runs, phases shows each step with its status (done, active, pending or skipped) and timing.

​
Follow a run live

GET /runs/{run_id}/progress streams the run’s progress as Server-Sent Events:
If the connection drops, reconnect with the Last-Event-ID header (or ?after= with the last event id) to resume without missing events.

​
List your runs

GET /runs returns your events and companies runs, newest first. Filter with kind and cap with limit. Scheduled monitor runs are listed under monitors.

​
Cancel, rename, delete

​
Batches

A run of more than 50 companies is split into runs of up to 50 companies: a batch. POST /runs then returns a batch_id and the run_ids of every part.
Batches are part of Enterprise plans. Free and pay-as-you-go runs take up to 50 companies, so they never make a batch.
Work with the batch as one run: progress counts the parts and companies done out of the total. In the batch stream each event’s data has its part’s run_id, and the stream ends with batch_status.