Skip to main content

Get pipeline run

GET 
/platform/pipeline/:pipelineId/pipeline_run/:runId

Retrieve the status, timestamps and error trace for one execution. Both pipelineId and runId are required path parameters. Obtain runId from pipeline_run_id in List pipeline runs. The source documents a null response when the run does not exist for that pipeline.

Example request​

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

Response fields and monitoring​

The returned run contains id, pipeline_run_id, pipeline_id, last_status, created_at, updated_at and trace. last_status can be RUNNING, SUCCESS or FAILED. For a failed run, inspect trace; it is null when no error is recorded.

Poll this endpoint to monitor a running execution. You can calculate the interval between its creation and last update:

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

Errors and next steps​

A documented 500 error has msg set to There was an error retrieving the pipeline_run. and an error describing the failure. Use Get run logs when the error trace is insufficient.

Request​

Responses​

Pipeline run details