Skip to main content
POST
Create LinkedIn Monitor

Headers

x-api-key
string | null

Body

application/json
linkedin_url
string
required
fields
string[]
required
Minimum array length: 1
name
string
default:LinkedIn monitor
Required string length: 1 - 120
frequency
string
default:1w
first_check
enum<string>
default:now
Available options:
now,
next_tick
webhook_url
string | null
webhook_event_types
string[] | null
metadata
Metadata · object | null
is_active
boolean
default:true
idempotency_key
string | null
Maximum string length: 200

Response

Successful Response

One uploaded table, watched as a single thing.

row_count and active_row_count differ when rows have been switched off.

id
string
required
org_id
string
required
team_id
string | null
required
name
string
required
frequency
string
required
struct
Struct · object
required
tier
string
required
subject_type
string
required
research_plan
string | null
required
is_active
boolean
required
disabled_reason
string | null
required
webhook_url
string | null
required
webhook_event_types
string[]
required
metadata
Metadata · object | null
required
last_run_at
string | null
required
next_run_times
string[]
required
row_count
integer
required
active_row_count
integer
required
status
enum<string>
required

'starting' while an uploaded file's rows are still being added, 'failed' when adding them failed. Nothing is checked until it becomes 'active'. 'cancelled' means the owner cancelled it; 'paused' means it was switched off without cancellation.

Available options:
starting,
failed,
active,
paused,
cancelled
created_at
string
required
updated_at
string
required
monitor_type
enum<string>
default:research
Available options:
research,
linkedin