Skip to content

Get Waterfall Job Progress

GET
/enrichment/waterfall/jobs/{job_id}/progress

How a waterfall enrichment job is going. FREE - polling costs nothing.

Per-provider progress for a job already running. GET /enrichment/jobs/ {job_id} is the general job read; this one breaks the waterfall down by the provider each record is currently on.

Authorizations

Parameters

Path Parameters

job_id
required

Waterfall job id.

string

Waterfall job id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string