Overview

Retrieve detailed information about a specific pipeline execution run, including status, timestamps, and any error traces.

Path Parameters

Parameter	Type	Description
`pipelineId`	string	The pipeline identifier
`runId`	string	The pipeline run identifier

Example

Get Successful Run Details

GET /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d/pipeline_run/e7c91a3b_5f2d_4a8e_b1c9_7d3f2e8a4b6c

Response (200 OK):

{
  "id": 45,
  "pipeline_run_id": "e7c91a3b_5f2d_4a8e_b1c9_7d3f2e8a4b6c",
  "pipeline_id": "1b33ad2f_33d3_4837_9eeb_83c82c8b909d",
  "last_status": "SUCCESS",
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-01-15T10:45:23.000Z",
  "trace": null
}

Get Failed Run Details

GET /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d/pipeline_run/f9d8e7c6_b5a4_3928_1c0d_6e5f4a3b2c1d

Response (200 OK):

{
  "id": 43,
  "pipeline_run_id": "f9d8e7c6_b5a4_3928_1c0d_6e5f4a3b2c1d",
  "pipeline_id": "1b33ad2f_33d3_4837_9eeb_83c82c8b909d",
  "last_status": "FAILED",
  "created_at": "2024-01-13T06:00:00.000Z",
  "updated_at": "2024-01-13T06:15:12.000Z",
  "trace": "Connection timeout: Unable to connect to source database after 30 seconds"
}

Get Running Execution Details

GET /platform/pipeline/a9f82c14_7e21_4b5a_8c9d_12345abcdef0/pipeline_run/b3c4d5e6_7f8a_9b0c_1d2e_3f4a5b6c7d8e

Response (200 OK):

{
  "id": 46,
  "pipeline_run_id": "b3c4d5e6_7f8a_9b0c_1d2e_3f4a5b6c7d8e",
  "pipeline_id": "a9f82c14_7e21_4b5a_8c9d_12345abcdef0",
  "last_status": "RUNNING",
  "created_at": "2024-01-15T14:00:00.000Z",
  "updated_at": "2024-01-15T14:00:00.000Z",
  "trace": null
}

Response Structure

Field	Type	Description
`id`	integer	Internal database ID
`pipeline_run_id`	string	Unique run identifier
`pipeline_id`	string	Parent pipeline identifier
`last_status`	string	Current status of the run
`created_at`	timestamp	When the run started
`updated_at`	timestamp	When the run was last updated
`trace`	string	Error trace or additional information (null if no errors)

Run Status Values

Status	Description
`RUNNING`	Execution currently in progress
`SUCCESS`	Execution completed successfully
`FAILED`	Execution failed (check `trace` for details)

Error Responses

500 Internal Server Error

{
  "msg": "There was an error retrieving the pipeline_run.",
  "error": "Database connection error"
}

Calculating Run Duration

You can calculate the execution duration by comparing timestamps:

const startTime = new Date(run.created_at);
const endTime = new Date(run.updated_at);
const durationMs = endTime - startTime;
const durationMinutes = Math.round(durationMs / 60000);

Use Cases

Debug Failed Execution

# 1. Get the run details
GET /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d/pipeline_run/f9d8e7c6_b5a4_3928_1c0d_6e5f4a3b2c1d

# 2. Check the trace field for error details
# 3. If more details needed, get the logs
GET /platform/pipeline/pipeline_run/f9d8e7c6_b5a4_3928_1c0d_6e5f4a3b2c1d/logs

Monitor In-Progress Execution

Poll the endpoint to check if a running execution has completed:

# Check status periodically
GET /platform/pipeline/1b33ad2f_33d3_4837_9eeb_83c82c8b909d/pipeline_run/e7c91a3b_5f2d_4a8e_b1c9_7d3f2e8a4b6c

Notes

Returns null if the specified run does not exist for the pipeline
The trace field contains error information when last_status is FAILED
For a list of all runs, use GET /platform/pipeline/:pipelineId/pipeline_run
To retrieve detailed logs, use GET /platform/pipeline/pipeline_run/:runId/logs