Skip to main content
GET
Get Run
This endpoint retrieves detailed information about a specific run using its hash ID. A run represents an execution instance of a squid’s tasks, tracking progress, status, and results.

Headers

string
required
Your API authentication token. Value: Token YOUR_API_KEY

Query Parameters

string
required
The unique identifier (hash) of the run. Example: 0393be3ea6f74986906153df1c3f9894

Response Field Explanations

string
Unique identifier of the squid run. Example: "0393be3ea6f74986906153df1c3f9894"
string
Type of returned object (always “run”). Example: "run"
string
Date and time when the run was initially created (ISO 8601). Example: "2025-02-04T10:26:50.847633"
string
Date and time when the scraping run started executing. Example: "2025-02-04T10:25:41.623683"
string | null
Date and time when the scraping run completed or stopped. Example: "2025-02-04T10:26:52.222239"
string
Duration of the scraping run as a formatted timedelta string. Example: "0:00:50.183300"
float
Total credits consumed during the run. Example: 50.1833
string
Origin of the run initiation (e.g., “user”, “schedule”). Example: "user"
string
Current status of the squid run (see statuses table). Example: "done"
integer
Total number of results collected. Example: 40
integer
Number of unique results collected. Example: 40
boolean
Indicates if the export was successfully generated. Example: true
string | null
Date and time when export was generated. Example: "2025-02-04T10:26:53.780636"
string | null
Reason indicating why the run finished (see done reasons table). Example: "tasks_done"
string | null
Additional description providing context for done_reason. Example: null
string
Identifier of the squid this run belongs to. Example: "e445405ef4ab41208ef7d29b92a1a9dd"
string | null
Scheduled date/time for the next execution (if recurring). Example: null
boolean
Whether this run was force-launched. Example: false
integer
Number of times results have been exported. Example: 1
boolean
Whether the email delivery was completed. Example: false
string | null
Timestamp when email delivery completed. Example: null
string | null
Email verification status for delivery. Example: null
boolean
Shorthand flag indicating whether the run has completed (any terminal status). Example: true

Run Statuses

Done Reasons

Use the status field to track run progress. Poll this endpoint periodically for long-running scrapes.
The done_reason field provides insight into why a run ended - useful for debugging failed runs.
Runs with status ‘error’ or unexpected done_reasons may indicate account issues that need attention.

Code Examples

Response

200
404