Data Diffs

Get a data diff summary

Structured counts for a completed data diff: primary-key stats, value stats, and — for same-database diffs — a schema section.

The response shape depends on the diff’s state and engine, so branch on status and on which sections are present rather than assuming a fixed payload:

running — only status. (The model also permits pending; the server does not currently emit it.)
error — status plus error.
success on a same-database diff — ApiDataDiffSummaryForDone, including schema.
success on a cross-database diff — ApiCrossDataDiffSummaryForDone, which has no schema section. Schema drift is not reported on this endpoint for cross-database diffs (nor by diff_stats.diff_schema, which is 0 for all of them); read it via the MCP tools get_datadiff_overview or get_datadiff_result_section(section="columns").

GET

api

datadiffs

{datadiff_id}

summary_results

Get a data diff summary

curl --request GET \
  --url https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results', 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://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results",
  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: <api-key>"
  ],
]);

$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://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "dependencies": [
    {
      "data_source_id": 123,
      "data_source_type": "<string>",
      "item_type": "<string>",
      "name": "<string>",
      "path": [
        "<string>"
      ],
      "uid": "<string>",
      "popularity": 123,
      "primary_key": "<string>",
      "query_type": "<string>",
      "raw_sql": "<string>",
      "remote_id": "<string>",
      "table_name": "<string>"
    }
  ],
  "materialized_results": {
    "diff": [
      {
        "data_source_id": 123,
        "is_sampled": true,
        "path": [
          "<string>"
        ],
        "url": "<string>"
      }
    ],
    "duplicates1": [
      {
        "data_source_id": 123,
        "is_sampled": true,
        "path": [
          "<string>"
        ],
        "url": "<string>"
      }
    ],
    "duplicates2": [
      {
        "data_source_id": 123,
        "is_sampled": true,
        "path": [
          "<string>"
        ],
        "url": "<string>"
      }
    ],
    "exclusives": [
      {
        "data_source_id": 123,
        "is_sampled": true,
        "path": [
          "<string>"
        ],
        "url": "<string>"
      }
    ]
  },
  "pks": {
    "distincts": [
      123,
      123
    ],
    "dupes": [
      123,
      123
    ],
    "exclusives": [
      123,
      123
    ],
    "nulls": [
      123,
      123
    ],
    "total_rows": [
      123,
      123
    ]
  },
  "schema": {
    "column_counts": [
      123,
      123
    ],
    "column_reorders": 123,
    "column_type_differs": [
      "<string>"
    ],
    "column_type_mismatches": 123,
    "columns_mismatched": [
      123,
      123
    ],
    "exclusive_columns": [
      [
        "<string>"
      ]
    ]
  },
  "status": "done",
  "created_at": "2023-11-07T05:31:56Z",
  "data_source1_id": 123,
  "data_source2_id": 123,
  "exclude_columns": [
    "<string>"
  ],
  "exclusives_profile": {
    "t1": {
      "columns": {}
    },
    "t2": {
      "columns": {}
    }
  },
  "file1": "<string>",
  "file2": "<string>",
  "filter1": "<string>",
  "filter2": "<string>",
  "include_columns": [
    "<string>"
  ],
  "pk_columns": [
    "<string>"
  ],
  "query1": "<string>",
  "query2": "<string>",
  "sampling_ratio": 123,
  "table1": [
    "<string>"
  ],
  "table2": [
    "<string>"
  ],
  "values": {
    "columns_diff_stats": [
      {
        "column_name": "<string>",
        "match": 123,
        "values_different": 123,
        "values_different_estimate": {
          "confidence": 123,
          "estimate": 123,
          "interval": {
            "max": 123,
            "min": 123
          },
          "value": 123
        }
      }
    ],
    "columns_with_differences": 123,
    "compared_columns": 123,
    "rows_with_differences": 123,
    "total_rows": 123,
    "total_values": 123,
    "values_with_differences": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Use the 'Authorization' header with the format 'Key '

Path Parameters

datadiff_id

integer

required

Response

Successful Response

ApiDataDiffSummaryForDone
ApiCrossDataDiffSummaryForDone
ApiDataDiffSummaryForFailed
ApiDataDiffSummaryForRunning
InternalApiDataDiffDependencies

Same-database (join, or unset algorithm) summary of a completed diff. Carries the schema section; its cross-database sibling ApiCrossDataDiffSummaryForDone does not — see that model for what is and isn't reported there.

dependencies

ApiCIDependency · object[]

required

Show child attributes

materialized_results

ApiMaterializedResults · object

required

Results of the diff, materialized into tables.

Show child attributes

pks

ApiDataDiffSummaryPKs · object

required

Show child attributes

schema

ApiDataDiffSummarySchema · object

required

Schema-comparison counts. Carried by ApiDataDiffSummaryForDone (same-database diffs) only — the cross-database variant has no schema field, see ApiCrossDataDiffSummaryForDone.

Scope: column presence, column order, and data types. Nullability and other column constraints are not compared, so a column that only dropped NOT NULL counts as matching here.

Show child attributes

status

enum<string>

required

Available options:

done,

success

created_at

string<date-time> | null

When the diff was created.

data_source1_id

integer | null

Data source of dataset A ("t1").

data_source2_id

integer | null

Data source of dataset B ("t2").

exclude_columns

string[] | null

Columns excluded from the comparison.

exclusives_profile

ApiExclusiveRowsProfile · object | null

Distribution statistics for exclusive rows (rows that exist in one table but not the other). Includes histograms and enum distributions for primary key columns. Only available for diffs computed after October 2025.

Show child attributes

file1

string | null

File URI for dataset A, when compared as a file.

file2

string | null

File URI for dataset B, when compared as a file.

filter1

string | null

Row filter applied to dataset A.

filter2

string | null

Row filter applied to dataset B.

include_columns

string[] | null

Columns compared (all shared columns if empty).

pk_columns

string[] | null

Primary key column names used for this diff.

query1

string | null

SQL for dataset A, when compared as a query.

query2

string | null

SQL for dataset B, when compared as a query.

sampling_ratio

number | null

Sampling ratio; null when the diff was not sampled.

table1

string[] | null

Path segments of dataset A, when a table.

table2

string[] | null

Path segments of dataset B, when a table.

values

ApiDataDiffSummaryValues · object | null

Show child attributes

⌘I

Get a data diff summary

curl --request GET \
  --url https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results', 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://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results",
  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: <api-key>"
  ],
]);

$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://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "dependencies": [
    {
      "data_source_id": 123,
      "data_source_type": "<string>",
      "item_type": "<string>",
      "name": "<string>",
      "path": [
        "<string>"
      ],
      "uid": "<string>",
      "popularity": 123,
      "primary_key": "<string>",
      "query_type": "<string>",
      "raw_sql": "<string>",
      "remote_id": "<string>",
      "table_name": "<string>"
    }
  ],
  "materialized_results": {
    "diff": [
      {
        "data_source_id": 123,
        "is_sampled": true,
        "path": [
          "<string>"
        ],
        "url": "<string>"
      }
    ],
    "duplicates1": [
      {
        "data_source_id": 123,
        "is_sampled": true,
        "path": [
          "<string>"
        ],
        "url": "<string>"
      }
    ],
    "duplicates2": [
      {
        "data_source_id": 123,
        "is_sampled": true,
        "path": [
          "<string>"
        ],
        "url": "<string>"
      }
    ],
    "exclusives": [
      {
        "data_source_id": 123,
        "is_sampled": true,
        "path": [
          "<string>"
        ],
        "url": "<string>"
      }
    ]
  },
  "pks": {
    "distincts": [
      123,
      123
    ],
    "dupes": [
      123,
      123
    ],
    "exclusives": [
      123,
      123
    ],
    "nulls": [
      123,
      123
    ],
    "total_rows": [
      123,
      123
    ]
  },
  "schema": {
    "column_counts": [
      123,
      123
    ],
    "column_reorders": 123,
    "column_type_differs": [
      "<string>"
    ],
    "column_type_mismatches": 123,
    "columns_mismatched": [
      123,
      123
    ],
    "exclusive_columns": [
      [
        "<string>"
      ]
    ]
  },
  "status": "done",
  "created_at": "2023-11-07T05:31:56Z",
  "data_source1_id": 123,
  "data_source2_id": 123,
  "exclude_columns": [
    "<string>"
  ],
  "exclusives_profile": {
    "t1": {
      "columns": {}
    },
    "t2": {
      "columns": {}
    }
  },
  "file1": "<string>",
  "file2": "<string>",
  "filter1": "<string>",
  "filter2": "<string>",
  "include_columns": [
    "<string>"
  ],
  "pk_columns": [
    "<string>"
  ],
  "query1": "<string>",
  "query2": "<string>",
  "sampling_ratio": 123,
  "table1": [
    "<string>"
  ],
  "table2": [
    "<string>"
  ],
  "values": {
    "columns_diff_stats": [
      {
        "column_name": "<string>",
        "match": 123,
        "values_different": 123,
        "values_different_estimate": {
          "confidence": 123,
          "estimate": 123,
          "interval": {
            "max": 123,
            "min": 123
          },
          "value": 123
        }
      }
    ],
    "columns_with_differences": 123,
    "compared_columns": 123,
    "rows_with_differences": 123,
    "total_rows": 123,
    "total_values": 123,
    "values_with_differences": 123
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Cloud

Audit Logs

CI

Data sources

Data diffs

Explore

BI

Monitors

Get a data diff summary

Authorizations

Path Parameters

Response