Runs & Results
Get run records
Page through records produced by a run. Supports JSON, JSONL, CSV, and column projection.
GET
Get run records
GET https://api-datahub.octoparse.com/v1/runs/{run_id}/records
Authentication: API key required (Authorization: Bearer <API Key>).
Page through records produced by a run. format supports json (default, enveloped with pagination), jsonl, and csv. fields is a comma-separated column projection.
You can read while the run is still in progress; you get what has been produced so far, and pagination.total keeps growing. Wait for a terminal state for the complete result. partial is true when the run partially succeeded or was cancelled; those records are valid and already billed.
You can only read runs you started. Another account’s run_id and a missing run_id both return 404.
Request
Path parameters
string
required
Run id.
Query parameters
integer
default:"0"
Pagination offset.Range ≥ 0.
integer
default:"100"
Page size, max 10000.Range 1 to 10000.
string
default:"json"
Output format.
json is enveloped with pagination; jsonl is one record per line; csv is tabular.Values: json / jsonl / csv.string
Comma-separated field names. Only these columns are returned, for example
title,price,url.Example request
Response
200 success
format=jsonl or format=csv, the response body is raw text without the envelope. Pagination parameters still apply.
The payload is wrapped in data. Fields:
string
Run id.
string
required
Dataset that holds the result.
object[]
required
Record array. Each item is shaped by the app
output_schema.record.boolean
Whether the run partially succeeded or was cancelled.
object
required
Pagination object.
Errors
Error responses use
{"error": {code, category, message, retryable}}. See Errors.