Enrichment Run

Enrichment fills in missing information on a record from Lightfield’s data providers.

Enrich a record

$ lightfield enrichment-run enrich

POST/v1/enrichmentRun/{entitySlug}/{entityId}

Get enrichment run status

$ lightfield enrichment-run get-enrichment-run

GET/v1/enrichmentRun/{runId}

ModelsExpand Collapse

enrichmentRun_enrich_response: object { enrichmentRun, manualFields, plannedFields, 2 more }

enrichmentRun: object { id, completedAt, createdAt, 7 more }

The run, or null when the request was skipped.

id: string

The enrichment run ID.

completedAt: string

When the run finished, or null while it is still open.

createdAt: string

entityId: string

The ID of the record being enriched.

entityType: "contact" or "account"

The type of record being enriched.

"contact"

"account"

startedAt: string

When the run began executing, or null while it is queued.

status: "queued" or "running" or "completed" or 2 more

Where the run is: queued and running are in flight; completed, failed and timed_out are final.

"queued"

"running"

"completed"

"failed"

"timed_out"

targetFields: array of string

The fields this run set out to fill.

trigger: "creation" or "manual" or "update"

What started the run: creation when the record was created, update when it later gained an email or account, manual when requested through the API.

"creation"

"manual"

"update"

updatedAt: string

manualFields: array of string

Under manual_fields_unconfirmed, the missing fields the workspace enriches only on request. Add them to fields to include them, as suggestions. Null otherwise.

plannedFields: array of string

Under manual_fields_unconfirmed, the fields a run would have filled. Name these in fields to enrich them without the fields enriched only on request. Null otherwise.

reason: "no_targets" or "no_operations" or "manual_fields_unconfirmed"

Why the request was skipped: no_targets when the workspace enriches nothing this record is missing, no_operations when no provider can be scheduled for the targeted fields — because none looks them up on request, or because the record lacks the inputs (such as an email or domain) a lookup would need. manual_fields_unconfirmed when fields was omitted and the record is missing fields the workspace enriches only on request: no run was started, and plannedFields and manualFields say what to name in a second request. Null otherwise.

"no_targets"

"no_operations"

"manual_fields_unconfirmed"

status: "started" or "already_running" or "skipped"

started when this request began a run, already_running when one was already enriching the record, skipped when there was nothing to enrich.

"started"

"already_running"

"skipped"

enrichmentRun_get_enrichment_run_response: object { id, completedAt, createdAt, 7 more }