Runs & Results
Get a run
Read run state, progress, error, usage, and billing. Supports long polling.
GET
Get a run
GET https://api-datahub.octoparse.com/v1/runs/{run_id}
Authentication: API key required (Authorization: Bearer <API Key>).
State, progress, error object, upstream reference, usage, and billing. When wait is greater than 0, the server holds the connection until the run reaches a terminal state or the wait times out. If it is still not terminal, call again with the same wait. Do not poll frequently with wait=0.
You can only read runs you started. Another account’s run_id and a missing run_id both return 404. Fields marked sensitive in the input contract are redacted on echo: write-only plaintext that even the starter cannot read back.
Request
Path parameters
string
required
Run id.
Query parameters
number
default:"0"
Long-poll seconds,
0–60. Default 0 returns immediately.Range 0 to 60.Example request
Response
200 success
data. Fields:
string
required
—
string
—
string
—
string
—
string
—
string
—
enum
required
Values:
PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED.object
—
object
—
string
—
boolean
—
boolean
true while cancellation has been requested and the run is still winding down (cooperative stop / partial-result recovery). Always false in terminal states (normalized server-side), so clients need not derive it from state.string
—
string
—
string
—
string
—
string
When a worker first claimed the run. Unlike
started_at, this is never rewritten on retry, so it is the anchor for queue time: queued = first_started_at - created_at, and total wall time = finished_at - first_started_at. Deriving queue time from started_at counts earlier attempts as queueing. null only for runs never claimed.string
—
object
Objective usage metering: how much the run did. Kept separate from billing; this is what evaluations compare against.
object
Billing ledger = usage × pricing × billing rules: how much is charged.
object
—
object[]
—
object[]
—
Errors
Error responses use
{"error": {code, category, message, retryable}}. See Errors.