List 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

publisher

runs

List 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 Authentication: API key required (Authorization: Bearer <API Key>). Every call against apps you published, newest first. This is the detail surface behind publisher usage: the same ownership (apps you own, including zero-release apps), the same range predicates and filter values, so any aggregate number can drill into the runs it counted. This is a whitelist view, not the caller’s run object: it tells you what happened (state, timestamps, records written back, error code and message, data fee the caller paid), but never who called, what they sent (no input), or what they got (no dataset_id, no records, no credential id). Callers still read through their own run list; a publisher cannot open the other party’s run with a run_id from here. Author debug runs are excluded by default; status accepts comma-separated multi-values.

Request

Query parameters

string[]

Limit to these apps. Repeatable.

string

Run state. Comma-separated multi-value.

string

Limit to one call channel.

string

Limit to runs pinned to this release version.

string

Limit to runs whose error code equals this value (the error_code from publisher usage group_by=error).

string

default:"production"

production (default) production traffic only; test your debug runs only; all both.

string

Inclusive start.

string

Exclusive end.

integer

default:"0"

Pagination offset.Range ≥ 0.

integer

default:"50"

Page size.Range 1 to 200.

Example request

curl \
  -H "Authorization: Bearer $OCTOPARSE_API_KEY" \
  "https://api-datahub.octoparse.com/v1/publisher/runs?data_app=carol/reviews-query&status=FAILED&limit=50"

Response

200 success

{
  "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"
  }
}

The payload is wrapped in data. Fields:

object[]

required

Run list.

Show fields

string

required

Run id.

string

Publisher username.

string

App name.

string

Pinned release version.

string

Build snapshot a debug run was pinned to; null for production runs.

string

Run kind (production / test, and so on).

enum

required

Run state. Values: PENDING / QUEUED / RUNNING / SUCCEEDED / PARTIALLY_SUCCEEDED / FAILED / CANCELLED / EXPIRED.

boolean

Whether the run partially succeeded or was cancelled with partial output.

string

Call channel.

string

Time the run was created.

string

Time execution started.

string

Time execution finished.

integer

Execution duration in milliseconds.

integer

Records written back.

number

Data fee paid by the caller.

object

Error object on failure.

Show fields

string

required

Stable error code.

string

Error category.

string

Developer-facing message.

boolean

Whether a retry of the same request can succeed.

object

Pagination info.

Show fields

integer

Requested offset.

integer

Requested page size.

integer

Number of items in this page.

integer

Filtered total.

boolean

Whether more pages remain.

string

Currency for amount.

Errors

HTTP	`code`	`category`	Description
401	`unauthorized`	`forbidden`	Missing or invalid API key.
400	`invalid-status`	`invalid_input`	`status` contains a value outside the vocabulary.
400	`invalid-run-kind`	`invalid_input`	`run_kind` is not an allowed value.
404	`app-not-found`	`not_found`	App does not exist, was renamed, or is invisible to the current credential (outside private / shared scope).

Error responses use {"error": {code, category, message, retryable}}. See Errors.

Client libraries

The Python and JavaScript SDKs do not wrap this endpoint yet. Call REST directly.

GET STARTED

QUICK START

REFERENCE

DATA HUB API

List publisher runs

Request

Query parameters

Example request

Response

200 success

Errors

Client libraries

​Request

​Query parameters

​Example request

​Response

​200 success

​Errors

​Client libraries

Request

Query parameters

Example request

Response

200 success

Errors

Client libraries