curl -X POST "https://YOUR_BASE_URL/comparisons" \
-H "Authorization: Bearer <api-key>" \
-H "Workspace-Id: <workspace-id>" \
-H "Content-Type: application/json" \
-d '{
"name": "orders table comparison",
"source_datasource_id": "aaaaaaaa-0000-0000-0000-000000000001",
"target_datasource_id": "bbbbbbbb-0000-0000-0000-000000000002",
"source_dataset_id": "cccccccc-0000-0000-0000-000000000003",
"target_dataset_id": "dddddddd-0000-0000-0000-000000000004",
"configuration": {
"source_columns": ["order_id", "customer_id", "total"],
"target_columns": ["order_id", "customer_id", "total"],
"primary_keys_source": ["order_id"],
"primary_keys_target": ["order_id"]
}
}'
import requests
url = "https://YOUR_BASE_URL/comparisons"
headers = {
"Authorization": "Bearer <api-key>",
"Workspace-Id": "<workspace-id>",
}
payload = {
"name": "orders table comparison",
"source_datasource_id": "aaaaaaaa-0000-0000-0000-000000000001",
"target_datasource_id": "bbbbbbbb-0000-0000-0000-000000000002",
"source_dataset_id": "cccccccc-0000-0000-0000-000000000003",
"target_dataset_id": "dddddddd-0000-0000-0000-000000000004",
"configuration": {
"source_columns": ["order_id", "customer_id", "total"],
"target_columns": ["order_id", "customer_id", "total"],
"primary_keys_source": ["order_id"],
"primary_keys_target": ["order_id"],
},
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
const payload = {
name: "orders table comparison",
source_datasource_id: "aaaaaaaa-0000-0000-0000-000000000001",
target_datasource_id: "bbbbbbbb-0000-0000-0000-000000000002",
source_dataset_id: "cccccccc-0000-0000-0000-000000000003",
target_dataset_id: "dddddddd-0000-0000-0000-000000000004",
configuration: {
source_columns: ["order_id", "customer_id", "total"],
target_columns: ["order_id", "customer_id", "total"],
primary_keys_source: ["order_id"],
primary_keys_target: ["order_id"],
},
};
const response = await fetch("https://YOUR_BASE_URL/comparisons", {
method: "POST",
headers: {
"Authorization": "Bearer <api-key>",
"Workspace-Id": "<workspace-id>",
"Content-Type": "application/json",
},
body: JSON.stringify(payload),
});
const data = await response.json();
console.log(data);
{
"message": "Comparison created successfully",
"data": {
"id": "eeeeeeee-0000-0000-0000-000000000005",
"name": "orders table comparison",
"source_dataset_id": "cccccccc-0000-0000-0000-000000000003",
"target_dataset_id": "dddddddd-0000-0000-0000-000000000004",
"configuration": {
"source_columns": ["order_id", "customer_id", "total"],
"target_columns": ["order_id", "customer_id", "total"],
"primary_keys_source": ["order_id"],
"primary_keys_target": ["order_id"],
"case_sensitive": false,
"quick_comparison": false
},
"workspace_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"user_id": "ffffffff-0000-0000-0000-000000000006"
}
}
Comparisons
Create Comparison
Create a new comparison between a source and target dataset.
POST
/
comparisons
curl -X POST "https://YOUR_BASE_URL/comparisons" \
-H "Authorization: Bearer <api-key>" \
-H "Workspace-Id: <workspace-id>" \
-H "Content-Type: application/json" \
-d '{
"name": "orders table comparison",
"source_datasource_id": "aaaaaaaa-0000-0000-0000-000000000001",
"target_datasource_id": "bbbbbbbb-0000-0000-0000-000000000002",
"source_dataset_id": "cccccccc-0000-0000-0000-000000000003",
"target_dataset_id": "dddddddd-0000-0000-0000-000000000004",
"configuration": {
"source_columns": ["order_id", "customer_id", "total"],
"target_columns": ["order_id", "customer_id", "total"],
"primary_keys_source": ["order_id"],
"primary_keys_target": ["order_id"]
}
}'
import requests
url = "https://YOUR_BASE_URL/comparisons"
headers = {
"Authorization": "Bearer <api-key>",
"Workspace-Id": "<workspace-id>",
}
payload = {
"name": "orders table comparison",
"source_datasource_id": "aaaaaaaa-0000-0000-0000-000000000001",
"target_datasource_id": "bbbbbbbb-0000-0000-0000-000000000002",
"source_dataset_id": "cccccccc-0000-0000-0000-000000000003",
"target_dataset_id": "dddddddd-0000-0000-0000-000000000004",
"configuration": {
"source_columns": ["order_id", "customer_id", "total"],
"target_columns": ["order_id", "customer_id", "total"],
"primary_keys_source": ["order_id"],
"primary_keys_target": ["order_id"],
},
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
const payload = {
name: "orders table comparison",
source_datasource_id: "aaaaaaaa-0000-0000-0000-000000000001",
target_datasource_id: "bbbbbbbb-0000-0000-0000-000000000002",
source_dataset_id: "cccccccc-0000-0000-0000-000000000003",
target_dataset_id: "dddddddd-0000-0000-0000-000000000004",
configuration: {
source_columns: ["order_id", "customer_id", "total"],
target_columns: ["order_id", "customer_id", "total"],
primary_keys_source: ["order_id"],
primary_keys_target: ["order_id"],
},
};
const response = await fetch("https://YOUR_BASE_URL/comparisons", {
method: "POST",
headers: {
"Authorization": "Bearer <api-key>",
"Workspace-Id": "<workspace-id>",
"Content-Type": "application/json",
},
body: JSON.stringify(payload),
});
const data = await response.json();
console.log(data);
{
"message": "Comparison created successfully",
"data": {
"id": "eeeeeeee-0000-0000-0000-000000000005",
"name": "orders table comparison",
"source_dataset_id": "cccccccc-0000-0000-0000-000000000003",
"target_dataset_id": "dddddddd-0000-0000-0000-000000000004",
"configuration": {
"source_columns": ["order_id", "customer_id", "total"],
"target_columns": ["order_id", "customer_id", "total"],
"primary_keys_source": ["order_id"],
"primary_keys_target": ["order_id"],
"case_sensitive": false,
"quick_comparison": false
},
"workspace_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"user_id": "ffffffff-0000-0000-0000-000000000006"
}
}
Comparison configuration.
Show configuration
Show configuration
Response
curl -X POST "https://YOUR_BASE_URL/comparisons" \
-H "Authorization: Bearer <api-key>" \
-H "Workspace-Id: <workspace-id>" \
-H "Content-Type: application/json" \
-d '{
"name": "orders table comparison",
"source_datasource_id": "aaaaaaaa-0000-0000-0000-000000000001",
"target_datasource_id": "bbbbbbbb-0000-0000-0000-000000000002",
"source_dataset_id": "cccccccc-0000-0000-0000-000000000003",
"target_dataset_id": "dddddddd-0000-0000-0000-000000000004",
"configuration": {
"source_columns": ["order_id", "customer_id", "total"],
"target_columns": ["order_id", "customer_id", "total"],
"primary_keys_source": ["order_id"],
"primary_keys_target": ["order_id"]
}
}'
import requests
url = "https://YOUR_BASE_URL/comparisons"
headers = {
"Authorization": "Bearer <api-key>",
"Workspace-Id": "<workspace-id>",
}
payload = {
"name": "orders table comparison",
"source_datasource_id": "aaaaaaaa-0000-0000-0000-000000000001",
"target_datasource_id": "bbbbbbbb-0000-0000-0000-000000000002",
"source_dataset_id": "cccccccc-0000-0000-0000-000000000003",
"target_dataset_id": "dddddddd-0000-0000-0000-000000000004",
"configuration": {
"source_columns": ["order_id", "customer_id", "total"],
"target_columns": ["order_id", "customer_id", "total"],
"primary_keys_source": ["order_id"],
"primary_keys_target": ["order_id"],
},
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
const payload = {
name: "orders table comparison",
source_datasource_id: "aaaaaaaa-0000-0000-0000-000000000001",
target_datasource_id: "bbbbbbbb-0000-0000-0000-000000000002",
source_dataset_id: "cccccccc-0000-0000-0000-000000000003",
target_dataset_id: "dddddddd-0000-0000-0000-000000000004",
configuration: {
source_columns: ["order_id", "customer_id", "total"],
target_columns: ["order_id", "customer_id", "total"],
primary_keys_source: ["order_id"],
primary_keys_target: ["order_id"],
},
};
const response = await fetch("https://YOUR_BASE_URL/comparisons", {
method: "POST",
headers: {
"Authorization": "Bearer <api-key>",
"Workspace-Id": "<workspace-id>",
"Content-Type": "application/json",
},
body: JSON.stringify(payload),
});
const data = await response.json();
console.log(data);
{
"message": "Comparison created successfully",
"data": {
"id": "eeeeeeee-0000-0000-0000-000000000005",
"name": "orders table comparison",
"source_dataset_id": "cccccccc-0000-0000-0000-000000000003",
"target_dataset_id": "dddddddd-0000-0000-0000-000000000004",
"configuration": {
"source_columns": ["order_id", "customer_id", "total"],
"target_columns": ["order_id", "customer_id", "total"],
"primary_keys_source": ["order_id"],
"primary_keys_target": ["order_id"],
"case_sensitive": false,
"quick_comparison": false
},
"workspace_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"user_id": "ffffffff-0000-0000-0000-000000000006"
}
}