Get enrichment run status

enrichment_run.get_enrichment_run() -> EnrichmentRunGetEnrichmentRunResponse

GET/v1/enrichmentRun/{runId}

Returns the status of an enrichment run by its ID.

Required scopes: contacts:read for a contact run, accounts:read for an account run

Rate limit category: Read

ParametersExpand Collapse

run_id: str

The enrichment run ID.

ReturnsExpand Collapse

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"]

What started the run: creation when the record was created, manual when requested through the API.

One of the following:

"creation"

"manual"

updated_at: str

Get enrichment run status

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
enrichment_run_get_enrichment_run_response = client.enrichment_run.get_enrichment_run(
    "runId",
)
print(enrichment_run_get_enrichment_run_response.id)

{
  "id": "id",
  "completedAt": "completedAt",
  "createdAt": "createdAt",
  "entityId": "entityId",
  "entityType": "contact",
  "startedAt": "startedAt",
  "status": "queued",
  "targetFields": [
    "string"
  ],
  "trigger": "creation",
  "updatedAt": "updatedAt"
}

Returns Examples

{
  "id": "id",
  "completedAt": "completedAt",
  "createdAt": "createdAt",
  "entityId": "entityId",
  "entityType": "contact",
  "startedAt": "startedAt",
  "status": "queued",
  "targetFields": [
    "string"
  ],
  "trigger": "creation",
  "updatedAt": "updatedAt"
}