Pipeline Execution Details

Returns the full details of a pipeline execution, including its current status, trigger, timings, and result message. If you only need to poll for status changes, consider using the lightweight getExecutionStatusOnly endpoint instead.

GET /v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId}

Pipeline Execution Details

cURL

curl --request GET \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/pipeline-executions/{pipelineExecutionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "environmentName": "Dev",
  "finishedAt": "2023-11-07T05:31:56Z",
  "message": "\"Rewrite Table\": Success",
  "pipelineExecutionId": "fd05a6c4-b3e1-4441-86a2-044d5092731d",
  "pipelineName": "My Pipeline",
  "pipelineType": "ORCHESTRATION",
  "projectId": "4a8a6162-702b-4efc-b2ec-c986e0bc95e4",
  "scheduleId": "9e2a6b04-ddd7-4bb4-b7dc-56e3b6f3ed43",
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "RUNNING",
  "trigger": "SCHEDULE",
  "user": "A User"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

a valid bearer token

Path Parameters

projectId · string · required

pipelineExecutionId · string<uuid> · required

Response

200

application/json

Pipeline execution details have been retrieved

environmentName · string

The name of the environment the pipeline was executed in

Example:

"Dev"

finishedAt · string<date-time>

The time the pipeline execution finished

message · string

The message returned by the pipeline execution

Example:

"\"Rewrite Table\": Success"

pipelineExecutionId · string

The ID of the pipeline execution

Example:

"fd05a6c4-b3e1-4441-86a2-044d5092731d"

pipelineName · string

The name of the pipeline executed

Example:

"My Pipeline"

pipelineType · string

The type of pipeline executed

Example:

"ORCHESTRATION"

projectId · string

The id of the project the pipeline was executed in

Example:

"4a8a6162-702b-4efc-b2ec-c986e0bc95e4"

scheduleId · string

The id of the schedule that triggered the pipeline execution if trigger is SCHEDULE

Example:

"9e2a6b04-ddd7-4bb4-b7dc-56e3b6f3ed43"

startedAt · string<date-time>

The time the pipeline execution started

status · string

Status of executed pipeline

Example:

"RUNNING"

trigger · enum<string>

The trigger of the pipeline execution

Available options: DESIGNER, API, SCHEDULE, SCHEDULE_RUN_NOW, UNKNOWN

Example:

"SCHEDULE"

user · string

The user that triggered the pipeline execution. Present when trigger is DESIGNER or SCHEDULE_RUN_NOW

Example:

"A User"