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

# Listar ejecuciones

> Lista cada ejecución que iniciaste. Filtra por estado, app, credencial, canal, tipo y rango temporal.

**`GET`** `https://api-datahub.octoparse.com/v1/runs`

Autenticación: se requiere API key (`Authorization: Bearer <API Key>`).

Todas las ejecuciones que iniciaste. La propiedad es por **cuenta**: las iniciadas con API key, SDK, MCP o login web aparecen en la misma lista. Siempre de más reciente a más antigua por hora de inicio. `pagination.total` es el total filtrado.

Los filtros se pueden combinar. `status` admite valores separados por comas (OR). `credential` es el id estable no sensible de la credencial de inicio, útil para ver qué clave consume cuota. `created_from` / `created_to` usan la hora de inicio, inicio inclusivo y fin exclusivo. El vocabulario coincide con <a href="/docs/es/datahub/api/reference/account/get-billing">Agregación de facturación</a>: pasa una clave de grupo de facturación sin cambios para profundizar en las ejecuciones correspondientes.

Cada ítem incluye `billing` y `usage`, así que la conciliación por ejecución no necesita una llamada de detalle aparte. La redacción del eco de entrada coincide con el detalle de ejecución.

## Solicitud

### Parámetros de consulta

<ParamField query="status" type="string">
  Estado de la ejecución. Multivalor separado por comas. Valores fuera del vocabulario devuelven `400`.
</ParamField>

<ParamField query="credential" type="string">
  Id estable de la credencial de inicio. Toma el valor de la agregación de facturación `group_by=credential` → `credential`.
</ParamField>

<ParamField query="data_app" type="string">
  Referencia de app: `<namespace>/<app_name>` o `app_<hex>`.
</ParamField>

<ParamField query="triggered_by" type="string">
  Canal de inicio, por ejemplo `api` / `sdk` / `mcp` / `cli` / `web`.
</ParamField>

<ParamField query="created_from" type="string">
  Límite inferior de hora de inicio, inclusivo. Marca de tiempo ISO-8601 absoluta.
</ParamField>

<ParamField query="created_to" type="string">
  Límite superior de hora de inicio, exclusivo.
</ParamField>

<ParamField query="run_kind" type="string">
  `production` para ejecuciones normales; `test` para debug del autor.

  Valores: `test` / `production`.
</ParamField>

<ParamField query="offset" type="integer" default="0">
  Offset de paginación.

  Rango ≥ 0.
</ParamField>

<ParamField query="limit" type="integer" default="50">
  Tamaño de página, máximo 200.

  Rango 1 a 200.
</ParamField>

### Ejemplo de solicitud

```bash theme={null}
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"
```

## Respuesta

### 200 correcto

```json theme={null}
{
  "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
    }
  }
}
```

La carga útil va envuelta en `data`. Campos:

<ResponseField name="items" type="object[]" required>
  Lista de ejecuciones. Cada ítem coincide con los campos de detalle de ejecución (sin `sample_records`).

  <Expandable title="fields">
    <ResponseField name="run_id" type="string" required>
      —
    </ResponseField>

    <ResponseField name="namespace" type="string">
      —
    </ResponseField>

    <ResponseField name="app_name" type="string">
      —
    </ResponseField>

    <ResponseField name="app_version" type="string">
      —
    </ResponseField>

    <ResponseField name="build_id" type="string">
      —
    </ResponseField>

    <ResponseField name="run_kind" type="string">
      —
    </ResponseField>

    <ResponseField name="state" type="enum" required>
      Valores: `PENDING` / `QUEUED` / `RUNNING` / `SUCCEEDED` / `PARTIALLY_SUCCEEDED` / `FAILED` / `CANCELLED` / `EXPIRED`.
    </ResponseField>

    <ResponseField name="input" type="object">
      —
    </ResponseField>

    <ResponseField name="progress" type="object">
      —

      <Expandable title="fields">
        <ResponseField name="done" type="integer">
          —
        </ResponseField>

        <ResponseField name="total" type="integer">
          —
        </ResponseField>

        <ResponseField name="status_text" type="string">
          —
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="dataset_id" type="string">
      —
    </ResponseField>

    <ResponseField name="partial" type="boolean">
      —
    </ResponseField>

    <ResponseField name="cancel_requested" type="boolean">
      `true` mientras se ha solicitado la cancelación y la ejecución aún se está deteniendo (parada cooperativa / recuperación de resultado parcial). Siempre `false` en estados terminales (normalizado en el servidor), así que los clientes no necesitan derivarlo de `state`.
    </ResponseField>

    <ResponseField name="triggered_by" type="string">
      —
    </ResponseField>

    <ResponseField name="upstream_ref" type="string">
      —
    </ResponseField>

    <ResponseField name="created_at" type="string">
      —
    </ResponseField>

    <ResponseField name="started_at" type="string">
      —
    </ResponseField>

    <ResponseField name="first_started_at" type="string">
      Cuando un worker reclamó la ejecución por primera vez. A diferencia de `started_at`, no se reescribe en reintentos, así que es el ancla del tiempo en cola: en cola = `first_started_at - created_at`, y tiempo total de pared = `finished_at - first_started_at`. Derivar el tiempo en cola de `started_at` cuenta intentos anteriores como cola. `null` solo en ejecuciones nunca reclamadas.
    </ResponseField>

    <ResponseField name="finished_at" type="string">
      —
    </ResponseField>

    <ResponseField name="usage" type="object">
      Medición objetiva de uso: cuánto hizo la ejecución. Separada de la facturación; es lo que comparan las evaluaciones.

      <Expandable title="fields">
        <ResponseField name="metrics" type="object">
          —
        </ResponseField>

        <ResponseField name="duration_ms" type="integer">
          —
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="billing" type="object">
      Libro de facturación = uso × precios × reglas de facturación: cuánto se cobra.

      <Expandable title="fields">
        <ResponseField name="events" type="object[]">
          —
        </ResponseField>

        <ResponseField name="total" type="number">
          —
        </ResponseField>

        <ResponseField name="currency" type="string">
          —
        </ResponseField>

        <ResponseField name="charged" type="boolean">
          —
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="error" type="object">
      —

      <Expandable title="fields">
        <ResponseField name="code" type="string" required>
          —
        </ResponseField>

        <ResponseField name="category" type="string">
          —
        </ResponseField>

        <ResponseField name="message" type="string" required>
          —
        </ResponseField>

        <ResponseField name="retryable" type="boolean">
          —
        </ResponseField>

        <ResponseField name="retry_after" type="number">
          —
        </ResponseField>

        <ResponseField name="item_index" type="integer">
          —
        </ResponseField>

        <ResponseField name="details" type="object[]">
          —
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="pagination" type="object">
  Objeto de paginación.

  <Expandable title="fields">
    <ResponseField name="offset" type="integer">
      —
    </ResponseField>

    <ResponseField name="limit" type="integer">
      —
    </ResponseField>

    <ResponseField name="count" type="integer">
      —
    </ResponseField>

    <ResponseField name="total" type="integer">
      —
    </ResponseField>

    <ResponseField name="has_more" type="boolean">
      —
    </ResponseField>
  </Expandable>
</ResponseField>

### Errores

| HTTP | `code`           | `category`      | Descripción                                       |
| ---- | ---------------- | --------------- | ------------------------------------------------- |
| 401  | `unauthorized`   | `forbidden`     | API key ausente o no válida.                      |
| 400  | `invalid-status` | `invalid_input` | `status` contiene un valor fuera del vocabulario. |

Las respuestas de error usan `{"error": {code, category, message, retryable}}`. Véase <a href="/docs/es/datahub/api/reference/introduction#errors">Errores</a>.

## Bibliotecas cliente

<CodeGroup>
  ```python Python theme={null}
  # Auto-paginar
  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"])

  # Usa la forma de página cuando necesites totales
  page = client.list_runs_page(status="QUEUED,RUNNING", limit=50)
  print(page["pagination"]["total"])
  ```

  ```js JavaScript theme={null}
  // Auto-paginar
  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);
  }

  // Usa la forma de página cuando necesites totales
  const page = await client.listRunsPage({ status: "QUEUED,RUNNING", limit: 50 });
  console.log(page.pagination.total);
  ```
</CodeGroup>