実行一覧
curl --request GET \
--url https://api.example.com/v1/runsimport requests
url = "https://api.example.com/v1/runs"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/runs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/runs")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"run_id": "<string>",
"namespace": "<string>",
"app_name": "<string>",
"app_version": "<string>",
"build_id": "<string>",
"run_kind": "<string>",
"state": {},
"input": {},
"progress": {
"done": 123,
"total": 123,
"status_text": "<string>"
},
"dataset_id": "<string>",
"partial": true,
"cancel_requested": true,
"triggered_by": "<string>",
"upstream_ref": "<string>",
"created_at": "<string>",
"started_at": "<string>",
"first_started_at": "<string>",
"finished_at": "<string>",
"usage": {
"metrics": {},
"duration_ms": 123
},
"billing": {
"events": [
{}
],
"total": 123,
"currency": "<string>",
"charged": true
},
"error": {
"code": "<string>",
"category": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123,
"item_index": 123,
"details": [
{}
]
}
}
],
"pagination": {
"offset": 123,
"limit": 123,
"count": 123,
"total": 123,
"has_more": true
}
}Runs & Results
実行一覧
開始した実行をフィルタ・ページングして一覧。
GET
/
v1
/
runs
実行一覧
curl --request GET \
--url https://api.example.com/v1/runsimport requests
url = "https://api.example.com/v1/runs"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/runs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/runs")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"run_id": "<string>",
"namespace": "<string>",
"app_name": "<string>",
"app_version": "<string>",
"build_id": "<string>",
"run_kind": "<string>",
"state": {},
"input": {},
"progress": {
"done": 123,
"total": 123,
"status_text": "<string>"
},
"dataset_id": "<string>",
"partial": true,
"cancel_requested": true,
"triggered_by": "<string>",
"upstream_ref": "<string>",
"created_at": "<string>",
"started_at": "<string>",
"first_started_at": "<string>",
"finished_at": "<string>",
"usage": {
"metrics": {},
"duration_ms": 123
},
"billing": {
"events": [
{}
],
"total": 123,
"currency": "<string>",
"charged": true
},
"error": {
"code": "<string>",
"category": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123,
"item_index": 123,
"details": [
{}
]
}
}
],
"pagination": {
"offset": 123,
"limit": 123,
"count": 123,
"total": 123,
"has_more": true
}
}GET https://api-datahub.octoparse.com/v1/runs
認証:APIキー必須(Authorization: Bearer <API Key>)。
自分が開始した全実行。所有はアカウント単位:API キー、SDK、MCP、Web ログイン開始分が同一一覧。開始時刻の新しい順。pagination.total はフィルタ後合計。
フィルタは併用可。status はカンマ区切り(OR)。credential は開始資格情報の非機微安定 id(どのキーが枠を消費するか追跡)。 created_from / created_to は開始時刻基準(開始 inclusive・終了 exclusive)。語彙は 請求集計: pass a billing group key through unchanged to drill into the matching runs.
各項目に billing と usage があり、実行単位の照合に詳細呼び出しは不要。入力エコーの伏字は実行詳細と同じ。
リクエスト
クエリパラメータ
string
実行状態。カンマ区切り複数値。語彙外は
400。string
開始資格情報の安定 id。請求集計
group_by=credential → credential の値を使う。string
App 参照:
<namespace>/<app_name> または app_<hex>。string
開始チャネル。例:
api / sdk / mcp / cli / web。string
開始時刻下限(inclusive)。絶対 ISO-8601。
string
開始時刻上限(exclusive)。
string
通常は
production。作者デバッグは test。値: test / production。integer
デフォルト:"0"
ページネーションオフセット。範囲 ≥ 0。
integer
デフォルト:"50"
Page size, max 200.Range 1 to 200.
リクエスト例
curl \
-H "Authorization: Bearer $OCTOPARSE_API_KEY" \
"https://api-datahub.octoparse.com/v1/runs?data_app=carol/probe-b&status=SUCCEEDED,PARTIALLY_SUCCEEDED&limit=50"
レスポンス
200 成功
{
"data": {
"items": [
{
"run_id": "run_3b750088f51c",
"namespace": "carol",
"app_name": "probe-b",
"app_version": "0.1.0",
"build_id": null,
"run_kind": "production",
"state": "RUNNING",
"input": {
"product": "p-doc"
},
"progress": {
"done": 0,
"total": null,
"status_text": null
},
"dataset_id": "ds_ec3ba97b8534",
"partial": false,
"cancel_requested": false,
"triggered_by": "api",
"upstream_ref": null,
"created_at": "2026-09-15T07:45:41.876601+00:00",
"started_at": "2026-09-15T07:45:41.883082+00:00",
"first_started_at": "2026-09-15T07:45:41.883082+00:00",
"finished_at": null,
"usage": {
"metrics": {
"records_collected": 0
},
"duration_ms": null
},
"billing": {
"events": [],
"total": 0.0,
"currency": "USD",
"charged": false
},
"error": null
},
"…"
],
"pagination": {
"offset": 0,
"limit": 2,
"count": 2,
"total": 2,
"has_more": false
}
}
}
data に包まれます。フィールド:
object[]
必須
実行一覧。各項目は実行詳細フィールドと同じ(
sample_records なし)。表示 fields
表示 fields
string
必須
—
string
—
string
—
string
—
string
—
string
—
enum
必須
値:
PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED。object
—
string
—
boolean
—
boolean
取消要求済みで収束中なら
true(協調停止/部分結果回収)。終端では常に false(サーバ正規化)。state から導出不要。string
—
string
—
string
—
string
—
string
ワーカーが初めて実行を引き受けた時刻。
started_at と違いリトライで上書きされないため壁時計の基準: queued = first_started_at - created_at、総壁時間 = finished_at - first_started_at。started_at から queued を取ると以前の試行を待ちと誤算。未割当のみ null。string
—
エラー
| HTTP | code | category | Description |
|---|---|---|---|
| 401 | unauthorized | forbidden | API キー欠落または無効。 |
| 400 | invalid-status | invalid_input | status に語彙外の値。 |
{"error": {code, category, message, retryable}} です。エラー を参照。
クライアントライブラリ
# Auto-paginate
for r in client.iterate_runs(data_app="carol/probe-b", created_from="2026-09-01T00:00:00+08:00"):
print(r["run_id"], r["state"], r["billing"]["total"])
# Use the page form when you need totals
page = client.list_runs_page(status="QUEUED,RUNNING", limit=50)
print(page["pagination"]["total"])
// Auto-paginate
for await (const r of client.iterateRuns({ dataApp: "carol/probe-b", createdFrom: "2026-09-01T00:00:00+08:00" })) {
console.log(r.run_id, r.state, r.billing.total);
}
// Use the page form when you need totals
const page = await client.listRunsPage({ status: "QUEUED,RUNNING", limit: 50 });
console.log(page.pagination.total);