Tasks

Get task status

Check an enrichment task's status, progress, credits used, and error details. Use the task ID returned at creation.

Check every few seconds until status is completed, failed, or stopped, then read links.results. Failed and stopped tasks can still have useful results.

Required permissions: enrichments:tasks:read

get/v1/enrichments/tasks/{taskId}

Authorizations

Authorizationstringheaderrequired

Use an account access token as Bearer <token>.

Get an access token ↗

Path parameters

taskIdstringrequired

Copy the task's returned @id unchanged. New tasks use a 32-character hexadecimal UUID4; existing IDs with the task_ prefix remain supported.

pattern: "^(?:task_)?[a-f0-9]{32}$"

Response

200404

Task metadata without raw inputs

200 · application/json

@idstringrequired

@typestringrequired

const: "EnrichmentTask"

enrichmentIdstringrequired

uniqueIdstringrequired

pattern: "^[A-Za-z0-9_-]+$"minLength: 1maxLength: 128

statusstringrequired

The task is active while queued, running, or stop_asked. Read results after completed, failed, or stopped. Reaching maxCredits can finish with partial results. A stop ends in stopped unless the task also fails.

Allowed values: "queued", "running", "stop_asked", "completed", "failed", "stopped"

errorobject | nullrequired

Null while the task is active or successfully completed. On failure, includes error details and a traceId when available. A stopped task can keep an error that occurred before it stopped.

Show child attributes

reasonstringrequired

Stable reason for a failed task.

Allowed values: "dispatch_failed", "deadline_exceeded", "worker_failed", "enrichment_failed", "credits_error"

codestringrequired

messagestringrequired

traceIdstring | nullrequired

createdAtstringrequired

format: "date-time"

startedAtstring | nullrequired

format: "date-time"

finishedAtstring | nullrequired

format: "date-time"

progressobjectrequired

Show child attributes

totalInputsintegerrequired

minimum: 1maximum: 10000

finishedInputsintegerrequired

minimum: 0maximum: 10000

outcomesobjectrequired

Show child attributes

successintegerrequired

minimum: 0

noResultintegerrequired

minimum: 0

errorintegerrequired

minimum: 0

skippedintegerrequired

minimum: 0

creditsobjectrequired

Show child attributes

usedstringrequired

pattern: "^[0-9]+(\\.[0-9]+)?$"

maxstring | nullrequired

Null when the caller omitted maxCredits (no limit).

pattern: "^[0-9]+(\\.[0-9]+)?$"

linksobjectrequired

Show child attributes

object

Additional properties are supported.

kindstringrequired

const: "enrichment"

Get task status

PythoncURLJavaScriptPHPGo

import requests

url = "https://api.datablist.com/v1/enrichments/tasks/<taskId>"

headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

Response · illustrative example

200404

{
  "@id": "string",
  "@type": "EnrichmentTask",
  "enrichmentId": "string",
  "uniqueId": "string",
  "status": "queued",
  "error": {
    "reason": "dispatch_failed",
    "code": "string",
    "message": "string",
    "traceId": "string"
  },
  "createdAt": "2024-07-29T15:51:28.071Z",
  "startedAt": "2024-07-29T15:51:28.071Z",
  "finishedAt": "2024-07-29T15:51:28.071Z",
  "progress": {
    "totalInputs": 0,
    "finishedInputs": 0
  },
  "outcomes": {
    "success": 0,
    "noResult": 0,
    "error": 0,
    "skipped": 0
  },
  "credits": {
    "used": "string",
    "max": "string"
  },
  "links": {},
  "kind": "enrichment"
}