Skip to content
LightfieldLightfield
API Reference

Enrichment Run

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

Enrich a record
enrichment_run.enrich(strentity_id, EnrichmentRunEnrichParams**kwargs) -> EnrichmentRunEnrichResponse
POST/v1/enrichmentRun/{entitySlug}/{entityId}
Get enrichment run status
enrichment_run.get_enrichment_run(strrun_id) -> EnrichmentRunGetEnrichmentRunResponse
GET/v1/enrichmentRun/{runId}
ModelsExpand Collapse
class EnrichmentRunEnrichResponse: …
enrichment_run: Optional[EnrichmentRun]

The run, or null when the request was skipped.

id: str

The enrichment run ID.

completed_at: Optional[str]

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

created_at: str
entity_id: str

The ID of the record being enriched.

entity_type: Literal["contact", "account"]

The type of record being enriched.

One of the following:
"contact"
"account"
started_at: Optional[str]

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

status: Literal["queued", "running", "completed", 2 more]

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

One of the following:
"queued"
"running"
"completed"
"failed"
"timed_out"
target_fields: List[str]

The fields this run set out to fill.

trigger: Literal["creation", "manual", "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.

One of the following:
"creation"
"manual"
"update"
updated_at: str
manual_fields: Optional[List[str]]

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

planned_fields: Optional[List[str]]

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: Optional[Literal["no_targets", "no_operations", "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.

One of the following:
"no_targets"
"no_operations"
"manual_fields_unconfirmed"
status: Literal["started", "already_running", "skipped"]

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

One of the following:
"started"
"already_running"
"skipped"
class EnrichmentRunGetEnrichmentRunResponse: …
id: str

The enrichment run ID.

completed_at: Optional[str]

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

created_at: str
entity_id: str

The ID of the record being enriched.

entity_type: Literal["contact", "account"]

The type of record being enriched.

One of the following:
"contact"
"account"
started_at: Optional[str]

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

status: Literal["queued", "running", "completed", 2 more]

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

One of the following:
"queued"
"running"
"completed"
"failed"
"timed_out"
target_fields: List[str]

The fields this run set out to fill.

trigger: Literal["creation", "manual", "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.

One of the following:
"creation"
"manual"
"update"
updated_at: str