Skip to main content
POST
Create Monitor

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Headers

Idempotency-Key
string | null

Makes a retry safe. Sending the same request again with the same key returns the monitor the first request created.

Maximum string length: 255

Body

application/json
name
string
required

Name of the monitor.

Required string length: 1 - 120
key_columns
string[]
required

Columns that identify a row, such as domain or linkedin_url. LinkedIn monitors need ["linkedin_url"].

Minimum array length: 1
Maximum string length: 100000
fields
required

What to watch. For research monitors, an object of field name to a sentence describing what to find. For LinkedIn monitors, a list of keys from GET /v1/monitors/linkedin-fields.

rows
Rows · object[]
required

The rows to watch, one object per company or person. To send a file instead, use POST /v1/monitors/upload.

Minimum array length: 1
first_check
enum<string>
default:now

When to run the first check. now starts it immediately when active; next_tick waits for the schedule. Sentinel checks all rows, including supplied values. Other research tiers initially enrich missing watched values; fully supplied rows wait for the schedule. next_run_times gives exact scheduled times.

Available options:
now,
next_tick
type
enum<string>
default:research

research re-researches each row and reports fields that changed. linkedin watches LinkedIn profile fields without research. Default: research.

Available options:
research,
linkedin
subject_type
enum<string>
default:company

What each row is: a company or a person. LinkedIn monitors need person. Default: company.

Available options:
company,
person
frequency
string | null

How often to check, such as 1d or 1w. Default: 1d for research monitors, 1w for LinkedIn monitors.

Maximum string length: 200
tier
enum<string>
default:low

Research depth for each check. Ignored for LinkedIn monitors. Default: low.

Available options:
low,
medium,
high,
sentinel
criteria
Criteria · object

Alert conditions, as an object of watched field key to a sentence. A change in that field is reported only when it meets the condition. Default: no conditions. LinkedIn monitors only.

research_plan
string | null

Additional instructions to guide the research. Research monitors only.

Maximum string length: 100000
webhook_url
string | null

HTTPS URL that receives the monitor's events.

Maximum string length: 2048
webhook_event_types
string[] | null

Events sent to webhook_url. Default: ["monitor.field.changed"].

Maximum array length: 4
Maximum string length: 200
metadata
Metadata · object | null

Your own data to store on the monitor. Returned as sent.

is_active
boolean
default:true

If true, the monitor runs on its schedule. If false, it is saved paused. Default: true.

Response

Successful Response

monitor_id
string
required

Monitor identifier.

type
enum<string>
required

research or linkedin.

Available options:
research,
linkedin
name
string
required

Name of the monitor.

status
enum<string>
required

starting while rows from a file are still being added, active when it runs on schedule, paused when switched off, failed when adding rows failed, canceled when canceled.

Available options:
starting,
active,
paused,
failed,
canceled
subject_type
enum<string>
required

What each row is.

Available options:
company,
person
fields
Fields · object
required

The watched fields.

frequency
string
required

How often the monitor checks its rows.

tier
string
required

Research depth for each check.

is_active
boolean
required

If true, the monitor runs on its schedule.

webhook_event_types
string[]
required

Events sent to webhook_url.

row_count
integer
required

Number of rows in the monitor.

active_row_count
integer
required

Number of rows that are still checked.

next_run_times
string[]
required

Up to three upcoming check times in UTC. Empty when not running.

created_at
string
required

Creation time in UTC, in ISO 8601 format.

updated_at
string
required

Last update time in UTC, in ISO 8601 format.

research_plan
string | null

Additional research instructions. Null when none were set.

disabled_reason
string | null

Why the monitor is not running. Null when it is running.

webhook_url
string | null

URL that receives the monitor's events. Null when none is set.

metadata
Metadata · object | null

Your own data stored on the monitor.

last_run_at
string | null

Start time of the most recent check in UTC. Null before the first check.