Skip to main content
POST
/
v1
/
projects
/
{projectId}
/
reviews
Review Pipeline Quality
curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/reviews \
  --header 'Agent-Version: <agent-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branchName": "main",
  "commitId": "7e3a9c4b2f1d8e6c0a5f9d2b4c7e1a3f4b6c8d0e",
  "dataWarehouseType": "SNOWFLAKE",
  "filePaths": [
    "file-1.orch.yaml",
    "another/file/with/path/file-2.trans.yaml"
  ]
}
'
import requests

url = "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/reviews"

payload = {
"branchName": "main",
"commitId": "7e3a9c4b2f1d8e6c0a5f9d2b4c7e1a3f4b6c8d0e",
"dataWarehouseType": "SNOWFLAKE",
"filePaths": ["file-1.orch.yaml", "another/file/with/path/file-2.trans.yaml"]
}
headers = {
"Agent-Version": "<agent-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'Agent-Version': '<agent-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
branchName: 'main',
commitId: '7e3a9c4b2f1d8e6c0a5f9d2b4c7e1a3f4b6c8d0e',
dataWarehouseType: 'SNOWFLAKE',
filePaths: ['file-1.orch.yaml', 'another/file/with/path/file-2.trans.yaml']
})
};

fetch('https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/reviews', 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}/reviews",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'branchName' => 'main',
'commitId' => '7e3a9c4b2f1d8e6c0a5f9d2b4c7e1a3f4b6c8d0e',
'dataWarehouseType' => 'SNOWFLAKE',
'filePaths' => [
'file-1.orch.yaml',
'another/file/with/path/file-2.trans.yaml'
]
]),
CURLOPT_HTTPHEADER => [
"Agent-Version: <agent-version>",
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/reviews"

payload := strings.NewReader("{\n \"branchName\": \"main\",\n \"commitId\": \"7e3a9c4b2f1d8e6c0a5f9d2b4c7e1a3f4b6c8d0e\",\n \"dataWarehouseType\": \"SNOWFLAKE\",\n \"filePaths\": [\n \"file-1.orch.yaml\",\n \"another/file/with/path/file-2.trans.yaml\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Agent-Version", "<agent-version>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/reviews")
.header("Agent-Version", "<agent-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"branchName\": \"main\",\n \"commitId\": \"7e3a9c4b2f1d8e6c0a5f9d2b4c7e1a3f4b6c8d0e\",\n \"dataWarehouseType\": \"SNOWFLAKE\",\n \"filePaths\": [\n \"file-1.orch.yaml\",\n \"another/file/with/path/file-2.trans.yaml\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Agent-Version"] = '<agent-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"branchName\": \"main\",\n \"commitId\": \"7e3a9c4b2f1d8e6c0a5f9d2b4c7e1a3f4b6c8d0e\",\n \"dataWarehouseType\": \"SNOWFLAKE\",\n \"filePaths\": [\n \"file-1.orch.yaml\",\n \"another/file/with/path/file-2.trans.yaml\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "excludedFiles": [
    "<string>"
  ],
  "results": {},
  "reviewStatus": "PASSED"
}
{
"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

Headers

Agent-Version
string
required

The agent version (e.g., "9.0.0")

Path Parameters

projectId
string<uuid>
required

The UUID of the project

Body

application/json

Review request containing pipeline context

branchName
string
required

${review.request.body.branchName}

Minimum string length: 1
Example:

"main"

commitId
string
required

The unique commit identifier used to retrieve associated pipelines

Minimum string length: 1
Example:

"7e3a9c4b2f1d8e6c0a5f9d2b4c7e1a3f4b6c8d0e"

dataWarehouseType
string
required

${review.request.body.dataWarehouseType}

Minimum string length: 1
Example:

"SNOWFLAKE"

filePaths
string[] | null

${review.request.body.filePaths}

Example:
[
"file-1.orch.yaml",
"another/file/with/path/file-2.trans.yaml"
]

Response

Pipeline quality review completed successfully

Response model for pipeline quality review

excludedFiles
string[]

List of files excluded from review due to unsupported file extensions

results
object

Map of pipeline names to their validation results

reviewStatus
string

Overall review status: PASSED or FAILED. FAILED if any rule failed with error enforcement.

Example:

"PASSED"