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"
  ]
}
'
{
  "excludedFiles": [
    "<string>"
  ],
  "results": {},
  "reviewStatus": "PASSED"
}

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"