GET/v1/tasks/{task_hash}

Get Task

Retrieve detailed information about a specific task

This endpoint retrieves detailed information about a specific task using its hash ID, including its current status, parameters, and execution history.

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes

Response Field Explanations

hash_value

string

Unique task identifier

Example: c5e29d2aba8b77cdc56391e7405302de

created_at

string

Task creation timestamp (ISO 8601)

Example: 2024-12-24T10:57:55.045567

is_active

boolean

Whether the task is active

Example: true

params

object

Task parameters (URL, search terms, etc.)

Example: {url: https://...}

module

integer

Internal module identifier

Example: 5

status

object

Detailed execution status information

Example: {...}

object

string

Always "task"

Example: task

Status Object Fields

status.status

string

Current task status (pending, running, completed, aborted, failed)

Example: completed

status.started_at

string

When task execution started

Example: 2025-02-04T10:25:47.278419

status.ended_at

string

When task execution ended

Example: 2025-02-04T10:26:52.310738

status.is_done

boolean

Whether the task has completed

Example: true

status.total_results

integer

Total number of results scraped

Example: 156

status.total_pages

integer

Total pages processed

Example: 1

status.done_reason

string

Reason for task completion (completed, run_aborted, error, etc.)

Example: completed

status.has_errors

boolean

Whether errors occurred during execution

Example: false

status.errors

stringnull

Error details if any occurred

Example: null

Parameters

task_hashstring

Required

The unique identifier (hash) of the task

Example: c5e29d2aba8b77cdc56391e7405302de

Pro Tip

Use the status.total_results field to track how much data has been collected for this task.

Note

The done_reason field helps identify why a task stopped - whether it completed normally, was aborted, or encountered errors.

Warning

Tasks with status 'aborted' may have partial results. Check total_results to see what was collected.