Tasks

List task history

List source tasks in your account, newest first. You can filter by status or sourceId. If nextCursor is not null, pass it unchanged as cursor to read the next page.

To find a task after a lost creation response, check each page for its uniqueId. There is no uniqueId query filter.

Required permissions: enrichments:tasks:read

get/v1/sources/tasks

Authorizations

Authorizationstringheaderrequired

Use an account access token as Bearer <token>.

Get an access token ↗

Query parameters

cursorstring

limitinteger

minimum: 1maximum: 100default: 50

statusstring

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"

sourceIdstring

Response

200401

Task page

200 · application/json

tasksobject[]required

Show child attributes

@idstringrequired

@typestringrequired

const: "SourceTask"

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"

createdAtstringrequired

format: "date-time"

startedAtstring | nullrequired

format: "date-time"

finishedAtstring | nullrequired

format: "date-time"

progressobjectrequired

Number of generated objects recorded so far.

Show child attributes

resultsintegerrequired

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

sourceIdstringrequired

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

nextCursorstring | nullrequired

List task history

PythoncURLJavaScriptPHPGo

import requests

url = "https://api.datablist.com/v1/sources/tasks"

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

params = {
    "limit": 50
}

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

print(response.text)

Response · illustrative example

200401

{
  "tasks": [
    {
      "@id": "string",
      "@type": "SourceTask",
      "uniqueId": "string",
      "status": "queued",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "startedAt": "2024-07-29T15:51:28.071Z",
      "finishedAt": "2024-07-29T15:51:28.071Z",
      "progress": {
        "results": 0
      },
      "credits": {
        "used": "string",
        "max": "string"
      },
      "links": {},
      "kind": "source",
      "sourceId": "string",
      "error": {
        "reason": "dispatch_failed",
        "code": "string",
        "message": "string",
        "traceId": "string"
      }
    }
  ],
  "nextCursor": "string"
}