Pipeline Executions

This returns a list of summarised pipeline executions.The list is ordered by the start time of the execution, with the most recent execution first. It can be paginated by providing a paginationToken query parameter obtained from a previous response.

GET /v1/pipeline-executions

Pipeline Executions

cURL

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

import requests

url = "https://eu1.api.matillion.com/dpc/v1/pipeline-executions"

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/pipeline-executions', 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/pipeline-executions",
  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/pipeline-executions"

	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/pipeline-executions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/pipeline-executions")

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

{
  "more": "<string>",
  "results": [
    {
      "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>"
  ]
}

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

Authorizations

Authorization · string · header · required

a valid bearer token

Query Parameters

projectId · string

Filter results to pipelines belonging to this project.

paginationToken · string

Token to fetch the next batch of results for a previous query.

limit · integer<int32> · default: 25

The maximum number of results to return (capped at 100).

pipelineName · string

Search against pipeline name, with case-insensitive partial matching.

environmentName · string

Filter results to pipelines executed within this environment.

startedAfter · string<date-time>

Filter results to pipelines started at or after this moment.

startedBefore · string<date-time>

Filter results to pipelines started at or before this moment.

timeFrame · string

Filter results to pipelines that started within this time frame, relative to now. Accepts an ISO-8601 duration string in the PnDTnHnMnS format, using days, hours, minutes and/or seconds, e.g. P1D, P7D, PT1H, PT30M, PT90S. Week, month and year units (P1W, P1M, P1Y) are not supported — use the day-based equivalents P7D, P30D and P365D instead.

status · enum<string>

Filter results to pipelines which have the status of one of the provided values.

Available options: RUNNING, SUCCESS, FAILED, CANCELLING, CANCELLED, FORBIDDEN, SKIPPED, UNKNOWN

scheduleId · string

Filter results to pipelines belonging to this schedule.

Response

200

application/json

Pipelines executions returned successfully

more · string

Token for fetching the next batch of results for this query; if omitted then there are no more.

results · object[]

Results of query

Show child attributes