> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Publisher run list (calls to my apps)

> Every call made to the apps I publish, most recent first — the
detail face behind GET /publisher/usage: the same ownership ("apps I
own", zero-Release apps included), the same range predicate
(`created_from` / `created_to` are ISO-8601 absolute timestamps,
inclusive start / exclusive end, by run start time) and the same
filter values, so any aggregate number drills down to exactly the
runs it counted.

This is a **whitelisted** view, not the caller's run object: it tells
you what happened (state, timing, records written back, error code
and message, data fee the caller paid) and never who called, what
they sent (`input`) or what they got back (no `dataset_id`, no
records, no credential identifier). Callers keep reading their own
runs through GET /runs; a publisher cannot open one of these run_ids
there. Debug traffic (run_kind=test) is excluded unless asked for;
`status` accepts comma-separated states (OR). Unknown or other
people's apps in `data_app` are 404 (no existence leak).



## OpenAPI

````yaml /jp/datahub/api/openapi.json get /v1/publisher/runs
openapi: 3.1.0
info:
  title: DataHub API
  version: 0.2.0
  description: Public /v1 contract of Octoparse DataHub. Internal channels are excluded.
servers:
  - url: https://api-datahub.octoparse.com
security:
  - bearerAuth: []
tags:
  - name: Discovery
    description: >-
      Anonymous access: platform metadata (currency), data app search, detail
      and input contract, machine-readable manifest spec.
  - name: Publishing
    description: >-
      Self-service publishing channel (API Key auth), two-phase: validate first
      (validate / package, nothing persisted), then publish (POST /data-apps,
      the submission goes live as a new Release). api kind (declarative
      integration) becomes visible on publish; code kind (code package) returns
      202 and enters an async image build; once ready it is promoted to a
      Release, visible and runnable. Poll progress via GET
      /data-apps/{ref}/builds.
  - name: Runs & Results
    description: >-
      Start / query / cancel runs and read result records with pagination.
      Business inputs go in the request body; platform run options (wait,
      max_records) go in query parameters.
  - name: Datasets
    description: >-
      Metadata and record access for platform datasets (including seeded stock
      data).
  - name: Account
    description: Account info and cumulative usage for the current API Key.
  - name: Secrets
    description: >-
      CRUD for upstream credentials (environment entries referenced by manifest
      `runtime.env`). Plaintext is write-only: every read returns a mask.
paths:
  /v1/publisher/runs:
    get:
      tags:
        - Publishing
      summary: Publisher run list (calls to my apps)
      description: |-
        Every call made to the apps I publish, most recent first — the
        detail face behind GET /publisher/usage: the same ownership ("apps I
        own", zero-Release apps included), the same range predicate
        (`created_from` / `created_to` are ISO-8601 absolute timestamps,
        inclusive start / exclusive end, by run start time) and the same
        filter values, so any aggregate number drills down to exactly the
        runs it counted.

        This is a **whitelisted** view, not the caller's run object: it tells
        you what happened (state, timing, records written back, error code
        and message, data fee the caller paid) and never who called, what
        they sent (`input`) or what they got back (no `dataset_id`, no
        records, no credential identifier). Callers keep reading their own
        runs through GET /runs; a publisher cannot open one of these run_ids
        there. Debug traffic (run_kind=test) is excluded unless asked for;
        `status` accepts comma-separated states (OR). Unknown or other
        people's apps in `data_app` are 404 (no existence leak).
      operationId: publisher_runs_v1_publisher_runs_get
      parameters:
        - name: data_app
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: >-
              restrict to these apps (`<username>/<app_name>`, repeatable);
              default = all my apps
            title: Data App
          description: >-
            restrict to these apps (`<username>/<app_name>`, repeatable);
            default = all my apps
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              run state, comma-separated multi-value OR (e.g. `FAILED` or
              `PENDING,QUEUED`); values outside the vocabulary are 400
            title: Status
          description: >-
            run state, comma-separated multi-value OR (e.g. `FAILED` or
            `PENDING,QUEUED`); values outside the vocabulary are 400
        - name: triggered_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              restrict to one calling channel (api / sdk / mcp / web …, same
              value as the runs list filter)
            title: Triggered By
          description: >-
            restrict to one calling channel (api / sdk / mcp / web …, same value
            as the runs list filter)
        - name: version
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: restrict to runs pinned to this Release version
            title: Version
          description: restrict to runs pinned to this Release version
        - name: error_code
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              restrict to runs whose error code equals this (the `error_code`
              key of GET /publisher/usage group_by=error)
            title: Error Code
          description: >-
            restrict to runs whose error code equals this (the `error_code` key
            of GET /publisher/usage group_by=error)
        - name: run_kind
          in: query
          required: false
          schema:
            type: string
            description: >-
              `production` (default) live traffic only, `test` my debug runs
              only, `all` both; platform health probes never appear; other
              values are 400 invalid-run-kind
            default: production
            title: Run Kind
          description: >-
            `production` (default) live traffic only, `test` my debug runs only,
            `all` both; platform health probes never appear; other values are
            400 invalid-run-kind
        - name: created_from
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Created From
        - name: created_to
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Created To
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope_PublisherRunList_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DataEnvelope_PublisherRunList_:
      properties:
        data:
          $ref: '#/components/schemas/PublisherRunList'
      type: object
      required:
        - data
      title: DataEnvelope[PublisherRunList]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PublisherRunList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PublisherRun'
          type: array
          title: Items
        pagination:
          $ref: '#/components/schemas/Pagination'
        currency:
          type: string
          title: Currency
      type: object
      required:
        - items
      title: PublisherRunList
      description: Page of calls to my apps, most recent first.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    PublisherRun:
      properties:
        run_id:
          type: string
          title: Run Id
        namespace:
          anyOf:
            - type: string
            - type: 'null'
          title: Namespace
        app_name:
          type: string
          title: App Name
          default: ''
        app_version:
          anyOf:
            - type: string
            - type: 'null'
          title: App Version
        build_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Build Id
          description: >-
            Build snapshot a debug run (run_kind=test) was pinned to; null for
            production runs
        run_kind:
          type: string
          title: Run Kind
          default: production
        state:
          $ref: '#/components/schemas/RunState'
        partial:
          type: boolean
          title: Partial
          default: false
        triggered_by:
          type: string
          title: Triggered By
          default: api
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        started_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Finished At
        duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration Ms
        records:
          type: integer
          title: Records
          default: 0
        amount:
          type: number
          title: Amount
          default: 0
        error:
          anyOf:
            - $ref: '#/components/schemas/PublisherRunError'
            - type: 'null'
      type: object
      required:
        - run_id
        - state
      title: PublisherRun
      description: |-
        One call to an app I publish, publisher perspective: what happened and
        what it cost the caller — never who called, what they sent or what they
        got back. `records` is the number of records written back; `amount` is
        the data fee the caller paid for this run (resource fees excluded), not
        the publisher's earnings.
    Pagination:
      properties:
        offset:
          type: integer
          title: Offset
          default: 0
        limit:
          type: integer
          title: Limit
          default: 0
        count:
          type: integer
          title: Count
          default: 0
        total:
          type: integer
          title: Total
          default: 0
        has_more:
          type: boolean
          title: Has More
          default: false
      type: object
      title: Pagination
    RunState:
      type: string
      enum:
        - PENDING
        - QUEUED
        - RUNNING
        - SUCCEEDED
        - PARTIALLY_SUCCEEDED
        - FAILED
        - CANCELLED
        - EXPIRED
      title: RunState
    PublisherRunError:
      properties:
        code:
          type: string
          title: Code
        category:
          type: string
          title: Category
          default: internal
        message:
          type: string
          title: Message
          default: ''
        retryable:
          type: boolean
          title: Retryable
          default: false
      type: object
      required:
        - code
      title: PublisherRunError
      description: |-
        Why a run failed, as the publisher may see it: code, category, the
        message and whether the caller could retry. Field-level `details` of
        input validation and retry hints stay with the caller.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: DataHub API Key

````