Get enrichment run status

client.enrichmentRun.getEnrichmentRun(, ?): EnrichmentRunGetEnrichmentRunResponse { id, completedAt, createdAt, 7 more }

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

runID: string

The enrichment run ID.

ReturnsExpand Collapse

EnrichmentRunGetEnrichmentRunResponse { id, completedAt, createdAt, 7 more }

id: string

The enrichment run ID.

completedAt: string | null

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

createdAt: string

entityId: string

The ID of the record being enriched.

entityType: "contact" | "account"

The type of record being enriched.

One of the following:

"contact"

"account"

startedAt: string | null

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

status: "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"

targetFields: Array<string>

The fields this run set out to fill.

trigger: "creation" | "manual"

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

One of the following:

"creation"

"manual"

updatedAt: string

Get enrichment run status

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const enrichmentRunGetEnrichmentRunResponse = await client.enrichmentRun.getEnrichmentRun('runId');

console.log(enrichmentRunGetEnrichmentRunResponse.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"
}