curl --request GET \
--url https://api.example.com/api/data-readiness/workflows/runs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/data-readiness/workflows/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/data-readiness/workflows/runs', 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://api.example.com/api/data-readiness/workflows/runs",
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://api.example.com/api/data-readiness/workflows/runs"
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://api.example.com/api/data-readiness/workflows/runs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/data-readiness/workflows/runs")
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{
"pagination": {
"page": 123,
"per_page": 123,
"total": 123,
"total_pages": 123,
"has_next": true,
"has_prev": true
},
"data": [
{
"asset_fqn": "PostgreSQL.dvdrental.public.customer",
"completed_at": "2024-01-15T10:35:00Z",
"configuration_id": "123e4567-e89b-12d3-a456-426614174000",
"database_name": "dvdrental",
"duration_seconds": 300.5,
"id": "123e4567-e89b-12d3-a456-426614174002",
"input": {
"asset_fqn": "PostgreSQL.dvdrental.public.customer"
},
"schema_name": "public",
"service_name": "PostgreSQL",
"started_at": "2024-01-15T10:30:00Z",
"status": "completed",
"table_name": "customer",
"workflow_name": "PII Detection - Production",
"workflow_type": "generate-pii-tags"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}List All Workflow Runs
Retrieve a paginated list of workflow runs across all workflows for the current tenant.
Supports filtering by:
asset_fqn: Filter runs by asset FQN (prefix match)workflow_type: Filter by workflow typestatus: Comma-separated status list (e.g., ‘running,failed,completed’). Valid statuses: pending, scheduled, running, completed, failed, cancelled, retrying, cached, crashedstart_date: Filter runs started after this date (ISO 8601)end_date: Filter runs started before this date (ISO 8601)
Supports sorting by:
sort: Multi-sort format: field:order,field:order (e.g., ‘status:desc,started_at:asc’). Valid fields: workflow_name, started_at, status. Valid orders: asc, desc
curl --request GET \
--url https://api.example.com/api/data-readiness/workflows/runs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/data-readiness/workflows/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/data-readiness/workflows/runs', 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://api.example.com/api/data-readiness/workflows/runs",
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://api.example.com/api/data-readiness/workflows/runs"
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://api.example.com/api/data-readiness/workflows/runs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/data-readiness/workflows/runs")
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{
"pagination": {
"page": 123,
"per_page": 123,
"total": 123,
"total_pages": 123,
"has_next": true,
"has_prev": true
},
"data": [
{
"asset_fqn": "PostgreSQL.dvdrental.public.customer",
"completed_at": "2024-01-15T10:35:00Z",
"configuration_id": "123e4567-e89b-12d3-a456-426614174000",
"database_name": "dvdrental",
"duration_seconds": 300.5,
"id": "123e4567-e89b-12d3-a456-426614174002",
"input": {
"asset_fqn": "PostgreSQL.dvdrental.public.customer"
},
"schema_name": "public",
"service_name": "PostgreSQL",
"started_at": "2024-01-15T10:30:00Z",
"status": "completed",
"table_name": "customer",
"workflow_name": "PII Detection - Production",
"workflow_type": "generate-pii-tags"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"code": "WORKFLOW_NOT_FOUND",
"message": "Workflow configuration with id '123e4567-e89b-12d3-a456-426614174000' not found",
"details": {
"workflow_id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"request_id": "req_abc123xyz"
}Authorizations
JWT Bearer token authentication. Include the token in the Authorization header as: Authorization: Bearer <token>. The JWT must contain valid client_id, and project_id claims for tenant isolation and SDK routing.
Query Parameters
Page number
x >= 1Items per page
1 <= x <= 100Filter by asset FQN (prefix match)
Filter by workflow type Workflow types available in the system.
These values match the Prefect deployment names defined in
scripts/prefect/deploy.py to enable direct mapping when triggering workflows.
generate-table-description, generate-pii-tags, generate-dq-tags, generate-sensitivity-tags, enrich-table-columns, service-ingestion, profiling, dq-rule-generation, dq-execution, metadata-assessment, dq-assessment, dq-tag-generation, intelligence, metadata-enrichment, run-all-enrichment Comma-separated status list (e.g., 'running,failed,completed'). Case-insensitive.
Start date (ISO 8601)
End date (ISO 8601)
Multi-sort format: field:order,field:order (e.g., 'status:desc,started_at:asc'). Valid fields: workflow_name, started_at, status. Valid orders: asc, desc
Was this page helpful?

