Enrichment

Get Waterfall Job 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.

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

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/enrichment/waterfall/jobs/{job_id}/progress
  • Auth: HTTP bearer

Path parameters

job_idstring required

Waterfall job id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataEnrichmentPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.