Skip to main content
POST
Create Watch

Overview

Creates a saved monitor that runs on every data sync. Five watch types (mark, portfolio, owner, class, similarity) share a single query shape; watch_type selects which scoping field is required. Your plan’s watch limit is enforced before insert. To see what a watch would catch before you create it, use Preview Watch, which returns the actual matching marks by default. Requires the portfolios:manage scope.

Body Parameters

string
required
Display name (1-255 chars).
string
required
One of mark, portfolio, owner, class, similarity. Each type requires a specific field to be populated, see the Watches guide for the table.
object
required
Watch query DSL.
string
Currently only always_per_alert is supported — one delivery per alert; any other value returns 400. Digest modes are planned but not yet available. See delivery_mode.
object
Free-form metadata (max 8KB).

Response

Returns the created Watch with status 201.
string
Watch ID (wat_*).
string
Always "watch".
string
Display name.
string
One of the five types.
object
Saved query DSL.
string
Delivery cadence.
string
Initial status: active.
integer | null
Null on create.
string | null
Null on create.
object
Echoed back.
string
ISO timestamp.
string
ISO timestamp.
string
Request identifier.

Errors

Code Examples