Skip to main content
POST
people.engagement.monitor.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
profileUrl
string
required

The public profile URL to watch, e.g. https://www.linkedin.com/in/jane-example.

backfill
boolean
default:false

Also capture past engagers where the source can. This roughly doubles the first charge, because the history is scraped alongside the first live month.

Response

The result

monitor
object
required

The monitor.

ref
string

Reference to what this call created. Pass it as ref to people.engagement.monitor.update, people.engagement.monitor.delete.