Skip to main content
GET
Get a data diff summary

Authorizations

Authorization
string
header
required

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

Path Parameters

datadiff_id
integer
required

Response

Successful Response

dependencies
ApiCIDependency · object[]
required
materialized_results
ApiMaterializedResults · object
required

Results of the diff, materialized into tables.

pks
ApiDataDiffSummaryPKs · object
required
schema
ApiDataDiffSummarySchema · object
required
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.

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