Skip to main content
Tasks

Get tasks results

Read results after an enrichment task is completed, failed, or stopped. While it is still active, this endpoint returns 409 ResultsNotReady.

Results keep the original input order and inputId. Failed and stopped tasks can contain partial results; a failure while submitting work can leave fewer results than inputs. The guide below explains result statuses and pagination.

Required permissions: enrichments:tasks:read

get/v1/enrichments/tasks/{taskId}/results

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}$"

Query parameters

cursorstring
limitinteger
minimum: 1maximum: 100default: 50

Response

Stable input-order result page

200 · application/json

taskIdstringrequired
resultsobject[]required
Show child attributes
inputIdstringrequired
statusstringrequired
Allowed values: "success", "no_result", "error", "skipped"
outputsobjectrequired
Show child attributes
object

Additional properties are supported.

creditsUsedstringrequired

Uses hundredth-credit precision, rounded upward.

pattern: "^[0-9]+(\\.[0-9]+)?$"
errorobject | nullrequired
Show child attributes
codestring
messagestring
nextCursorstring | nullrequired

Result statuses and pagination​

Results keep your input order and inputId, so you can match each one to your original record. Each result has one of four statuses:

  • success: outputs contains the enrichment response.
  • no_result: the call succeeded but found no data.
  • error: execution was attempted but failed, or its 24-hour deadline elapsed; error contains a stable public code and safe message.
  • skipped: the input was intentionally not executed after a task stop, such as MAX_CREDITS_REACHED or TASK_STOPPED.

Here is a Name to Domain result with sample data and a sample credit amount:

json
{
  "inputId": "company-123",
  "status": "success",
  "outputs": {
    "companyDomain": "example.com"
  },
  "creditsUsed": "1",
  "error": null
}

outputs contains the data found by the enrichment. Its fields depend on your settings and the data available. The catalog lists known fields, but extra fields can appear in results before they are listed there.

Result pages default to 50 items and accept limit values from 1 to 100. Pass nextCursor unchanged in the next request. A page can contain fewer items than requested when it reaches the response-size limit.

Read all result pages​

Replace TASK_ID with the ID returned when you created the task. Request the first page:

Request
import requests


url = "https://api.datablist.com/v1/enrichments/tasks/TASK_ID/results"


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


params = {
    "limit": "50"
}


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


print(response.text)

If the response has a nextCursor, copy it into the next request's cursor parameter. Replace NEXT_CURSOR below with that value:

Request
import requests


url = "https://api.datablist.com/v1/enrichments/tasks/TASK_ID/results"


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


params = {
    "limit": "50",
    "cursor": "NEXT_CURSOR"
}


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


print(response.text)

Repeat with each new nextCursor until it is null. A short page does not mean you have reached the end.

Partial results​

Read results for failed and stopped tasks too. Some inputs may have finished successfully before the task ended. Others may contain errors or be skipped.

If work could not be fully submitted, there may be fewer results than inputs. A failed task keeps results already saved; one failed input does not necessarily fail the whole task.