> ## 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.

# Read run result records

> Paginated read of the records produced by the run; `format`
supports json / jsonl / csv, `fields` selects columns
(comma-separated).

You can only read runs you started: someone else's run_id and a
nonexistent run_id both return 404.



## OpenAPI

````yaml /jp/datahub/api/openapi.json get /v1/runs/{run_id}/records
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/runs/{run_id}/records:
    get:
      tags:
        - Runs & Results
      summary: Read run result records
      description: |-
        Paginated read of the records produced by the run; `format`
        supports json / jsonl / csv, `fields` selects columns
        (comma-separated).

        You can only read runs you started: someone else's run_id and a
        nonexistent run_id both return 404.
      operationId: run_records_v1_runs__run_id__records_get
      parameters:
        - name: run_id
          in: path
          required: true
          schema:
            type: string
            title: Run Id
        - 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: 10000
            minimum: 1
            default: 100
            title: Limit
        - name: format
          in: query
          required: false
          schema:
            type: string
            pattern: ^(json|jsonl|csv)$
            default: json
            title: Format
        - name: fields
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Fields
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataEnvelope_RecordsPage_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DataEnvelope_RecordsPage_:
      properties:
        data:
          $ref: '#/components/schemas/RecordsPage'
      type: object
      required:
        - data
      title: DataEnvelope[RecordsPage]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RecordsPage:
      properties:
        run_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Run Id
        dataset_id:
          type: string
          title: Dataset Id
        records:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Records
        partial:
          type: boolean
          title: Partial
          default: false
        pagination:
          $ref: '#/components/schemas/Pagination'
      type: object
      required:
        - dataset_id
        - records
        - pagination
      title: RecordsPage
    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
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: DataHub API Key

````