Documentation

Add one competitor, or update the existing row when the domain is already in this project. Optional surfaces can be included. The same domain is never inserted twice.

Take a competitor off the watch. History stays. A later import or restore_competitor puts them back.

Get one competitor, the active pages and accounts being watched, the latest observation on each, and signals that have not been sent.

Add or update up to 50 competitors in one call. Match is the domain. An archived domain is brought back when it is imported again. Each row reports created, updated, or rejected. Pass surfaces on a row to set what to watch; omit surfaces to leave existing pages and accounts untouched.

List competitors in a project. Filter with status (proposed, active, paused, archived), kind, or due=true. Archived competitors are omitted unless status=archived.

Put an archived competitor back on the watch as active and due.

Change kind, priority, interval, website, status, or notes. Status here is proposed, active, or paused. Removing someone from the watch is archive_competitor.

Save what was seen on one surface. The first observation for that surface is a baseline and cannot by itself justify a signal. The same content is stored once and still counts as a completed check. Only active competitors can be checked.

Read one saved social account through the existing research provider, store the observation, and dedupe posts by URL. The project can spend 20 provider calls per day. The first snapshot is a baseline. A repeat of the same feed does not create another observation.

Create the product or project to watch, or return the existing project when this owner already used that name. A repeat does not overwrite the saved description or destinations.

Get one project plus counts of active competitors, competitors due for a check, and unsent signals.

List the products this owner is watching.

Change the project name, website, description, or signal destinations. Destinations.emails receives signals. webhook_url, when set, must be https and is posted the same JSON.

Keep a signal and do not send it. A sent signal cannot be dismissed.

List signals for a project. status is unsent, sent, or dismissed. unsent means recorded and not yet delivered.

Record a competitive change. Pass observation ids from this competitor. At least one must be a later observation rather than a baseline. This does not send the signal.

Deliver one signal once to the project email addresses and optional webhook. A second call returns the original delivery and does not send again. Fails with NO_DESTINATIONS when the project has nowhere to send. A partial failure stays unsent so only the failed destinations are retried.

Replace the pages and social accounts watched for one competitor. Social platforms are twitter (use this for X), instagram, linkedin, linkedin_page, and threads. A homepage, pricing page, changelog, or blog needs a public url.

Start every check run here. Returns unsent signals first, then at most 3 due competitors. Each competitor includes its surfaces and the latest observation, or needs_surfaces when nothing is being watched yet.