Skip to main content
POST
data.monitor.search.preview

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

Check a company-search monitor.

Allowed value: "company"
name
string

Company name.

Required string length: 1 - 256
industry
string

Industry or sector.

Required string length: 1 - 256
technology
string

A technology the company uses.

Required string length: 1 - 256
domain
string

Company website domain.

country
string

Two-letter country code like US.

Required string length: 1 - 2
Pattern: ^[A-Z]{2}$
everyHours
integer
default:24

The schedule you have in mind, in hours. Only the price estimate uses it.

Required range: 1 <= x <= 744
maxResultsPerRun
number

The per-run cap you have in mind. Default 25.

Required range: x >= 1
isRealtime
boolean
default:false

Check a realtime (live) monitor instead of an index one.

Response

The result

canCreate
boolean
required

Whether the monitor can be created as asked.

records
object[]
required

Up to five sample records in the dataset's own shape: a company, a person, a job or a post.

matchCount
number | null

How many records the search currently covers, when the source reports a count (a realtime monitor reports none).

perRecordCredits
number

The credits one delivered record will cost on the tier you chose.

problem
string

What to change when the monitor cannot be created as asked.