Skip to main content
POST
data.monitor.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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
dataset
enum<string>
required

Which dataset to list monitors on.

Available options:
company,
person,
job,
social_post
kind
enum<string>

Leave out to list both: saved-search (discovery) and watched-list (entity) monitors.

Available options:
discovery,
entity
status
enum<string>

Only monitors in this state.

Available options:
active,
paused,
suspended,
expired,
cancelled
limit
number

How many monitors to return, 1 to 200. Default 50.

Required range: x >= 1
offset
integer

Skip this many of your monitors first.

Required range: 0 <= x <= 9007199254740991

Response

The result

monitors
object[]
required

Your monitors, newest first.