Skip to main content
POST
data.monitor.run.read

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

The ref returned by data.monitor.runs.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

status
enum<string>
required

The run's state; records exist only on a successful run.

Available options:
running,
success,
failed,
skipped
newRecords
number
required

How many records the run delivered.

records
object[]
required

Every record the run delivered. A run over 1,000 records is delivered as one file the source fetches for you; the rows here are the same.

startedAt
string

When the run started, ISO 8601.

completedAt
string

When the run finished, ISO 8601.