Create Comparison - Datachecks

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"]
    }
  }'

{
  "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"
  }
}

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"]
    }
  }'

{
  "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"
  }
}

Authorization

string

required

Bearer token. Format: Bearer <api-key>

Workspace-Id

string

required

Your workspace UUID.

create_only

boolean

default:"false"

If true, creates the comparison without triggering execution.

name

string

required

Display name for the comparison.

source_datasource_id

string

required

UUID of the source data source.

target_datasource_id

string

required

UUID of the target data source.

source_dataset_id

string

UUID or name of the source dataset. Required if source_query is not set.

target_dataset_id

string

UUID or name of the target dataset. Required if target_query is not set.

configuration

object

required

Comparison configuration.

Show configuration

source_columns

array

required

List of column names to compare from the source dataset.

target_columns

array

required

List of column names to compare from the target dataset.

primary_keys_source

array

required

Primary key columns in the source dataset.

primary_keys_target

array

required

Primary key columns in the target dataset.

source_filter

string

SQL WHERE clause to filter source rows.

target_filter

string

SQL WHERE clause to filter target rows.

source_query

string

Custom SQL query for the source. Overrides source_dataset_id.

target_query

string

Custom SQL query for the target. Overrides target_dataset_id.

case_sensitive

boolean

default:"false"

Whether string comparisons are case-sensitive.

quick_comparison

boolean

default:"false"

Run a fast row-count-only comparison instead of a full diff.

schema_diff

boolean

default:"false"

Include schema differences in the comparison.

Response

data

object

The created comparison.

Show data

string

UUID of the comparison.

name

string

Comparison name.

source_dataset_id

string

Source dataset UUID.

target_dataset_id

string

Target dataset UUID.

configuration

object

The comparison configuration as stored.

workspace_id

string

Workspace UUID.

user_id

string

UUID of the user who created the comparison.

message

string

Status message.

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"]
    }
  }'

{
  "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"
  }
}

List Data Sources Execute Comparison

​Response

Response