Enrichment

Get Enrichment Records Progress

Per-record progress for enrichments in flight. FREE - a read.

POST only because the record list is a structured body. It reports which provider and step each record is on right now, which is what lets a client resume a view mid-run instead of showing a blank cell.

The app takes at most 500 ids and ignores the rest, so page through them rather than sending a whole list.

post/enrichment/records/progress

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/enrichment/records/progress
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

record_idsstring[]

Records to report on. The app caps this at 500 and ignores the rest.

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.