発行者実行一覧

発行者実行一覧

curl --request GET \
  --url https://api.example.com/v1/publisher/runs

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/publisher/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/publisher/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/publisher/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": {},
      "partial": true,
      "triggered_by": "<string>",
      "created_at": "<string>",
      "started_at": "<string>",
      "finished_at": "<string>",
      "duration_ms": 123,
      "records": 123,
      "amount": 123,
      "error": {
        "code": "<string>",
        "category": "<string>",
        "message": "<string>",
        "retryable": true
      }
    }
  ],
  "pagination": {
    "offset": 123,
    "limit": 123,
    "count": 123,
    "total": 123,
    "has_more": true
  },
  "currency": "<string>"
}

GET

publisher

runs

発行者実行一覧

curl --request GET \
  --url https://api.example.com/v1/publisher/runs

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/publisher/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/publisher/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/publisher/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": {},
      "partial": true,
      "triggered_by": "<string>",
      "created_at": "<string>",
      "started_at": "<string>",
      "finished_at": "<string>",
      "duration_ms": 123,
      "records": 123,
      "amount": 123,
      "error": {
        "code": "<string>",
        "category": "<string>",
        "message": "<string>",
        "retryable": true
      }
    }
  ],
  "pagination": {
    "offset": 123,
    "limit": 123,
    "count": 123,
    "total": 123,
    "has_more": true
  },
  "currency": "<string>"
}

GET https://api-datahub.octoparse.com/v1/publisher/runs 認証：APIキー必須（Authorization: Bearer <API Key>）。自分が公開した App に対するすべての呼び出し（新しい順）。発行者使用量の背後にある明細で、所有権（自分が所有する App。Release が 0 件の App を含む）、期間の条件、フィルター値はすべて同じなので、どの集計値からもそのカウント対象の実行まで掘り下げられる。これはホワイトリストビューであり、呼び出し元の実行オブジェクトではない：何が起きたか（状態、タイムスタンプ、書き戻されたレコード数、エラーコードとメッセージ、呼び出し元が支払ったデータ料金）はわかるが、誰が呼び出したか、何を送ったか（input なし）、何を受け取ったか（dataset_id、レコード、資格情報 ID なし）は決して含まれない。呼び出し元は引き続き自分の実行一覧から読み取る。発行者はここで得た run_id で相手の実行を開くことはできない。作者のデバッグ実行は既定で除外される。status はカンマ区切りの複数値を受け付ける。

リクエスト

クエリパラメータ

string[]

これらの App に限定する。繰り返し指定可。

string

実行の状態。カンマ区切りで複数指定可。

string

1 つの呼び出しチャネルに限定する。

string

この Release バージョンに固定された実行に限定する。

string

エラーコードがこの値と等しい実行に限定する（発行者使用量の group_by=error で得られる error_code）。

string

デフォルト:"production"

production（既定）は本番トラフィックのみ、test は自分のデバッグ実行のみ、all は両方。

string

開始（この時刻を含む）。

string

終了（この時刻を含まない）。

integer

デフォルト:"0"

ページネーションオフセット。範囲 ≥ 0。

integer

デフォルト:"50"

ページサイズ。範囲は 1〜200。

リクエスト例

curl \
  -H "Authorization: Bearer $OCTOPARSE_API_KEY" \
  "https://api-datahub.octoparse.com/v1/publisher/runs?data_app=carol/reviews-query&status=FAILED&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": "SUCCEEDED",
        "partial": false,
        "triggered_by": "api",
        "created_at": "2026-09-15T07:45:41.876601+00:00",
        "started_at": "2026-09-15T07:45:41.883082+00:00",
        "finished_at": "2026-09-15T07:45:42.326823+00:00",
        "duration_ms": 443,
        "records": 20,
        "amount": 0.02,
        "error": null
      },
      "…"
    ],
    "pagination": {
      "offset": 0,
      "limit": 2,
      "count": 2,
      "total": 2,
      "has_more": false
    },
    "currency": "CNY"
  }
}

ペイロードは data に包まれます。フィールド:

object[]

必須

実行の一覧。

表示 fields

string

必須

実行 id。

string

発行者ユーザー名。

string

App 名。

string

固定された Release バージョン。

string

デバッグ実行が固定された Build スナップショット。本番実行では null。

string

実行の種類（production / test など）。

enum

必須

実行の状態。値: PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED。

boolean

実行が部分的に成功したか、部分的な出力を残してキャンセルされたかどうか。

string

呼び出しチャネル。

string

実行の作成時刻。

string

実行の開始時刻。

string

実行の終了時刻。

integer

実行所要時間（ミリ秒）。

integer

書き戻されたレコード数。

number

呼び出し元が支払ったデータ料金。

object

失敗時のエラーオブジェクト。

表示 fields

string

必須

安定したエラーコード。

string

エラーカテゴリ。

string

開発者向けメッセージ。

boolean

同じリクエストを再試行して成功する可能性があるかどうか。

object

ページング情報。

表示 fields

integer

要求されたオフセット。

integer

要求されたページサイズ。

integer

このページの項目数。

integer

フィルター適用後の総数。

boolean

さらにページがあるかどうか。

string

amount の通貨。

エラー

HTTP	`code`	`category`	説明
401	`unauthorized`	`forbidden`	API キー欠落または無効。
400	`invalid-status`	`invalid_input`	`status` に語彙外の値。
400	`invalid-run-kind`	`invalid_input`	`run_kind` が許可された値ではない。
404	`app-not-found`	`not_found`	App が存在しない、名前が変更された、または現在の資格情報からは見えない（private / shared の範囲外）。

エラー応答は {"error": {code, category, message, retryable}} です。エラーを参照。

クライアントライブラリ

Python / JavaScript SDK はまだこのエンドポイントをラップしていません。REST を直接呼び出してください。

はじめに

クイックスタート

リファレンス

DATA HUB API

リクエスト

クエリパラメータ

リクエスト例

レスポンス

200 成功

エラー

クライアントライブラリ

​リクエスト

​クエリパラメータ

​リクエスト例

​レスポンス

​200 成功

​エラー

​クライアントライブラリ

リクエスト

クエリパラメータ

リクエスト例

レスポンス

200 成功

エラー

クライアントライブラリ