POST
/
api
/
v1
/
datadiffs

Authorizations

​
Authorization
string
headerrequired

Use the 'Authorization' header with the format 'Key <api-key>'

Body

application/json
​
data_source1_id
integer
required
​
data_source2_id
integer
required
​
pk_columns
string[]
required
​
algorithm
enum<string> | null
Available options:
join,
hash,
hash_v2_alpha,
fetch_and_join
​
archived
boolean
default: false
​
bisection_factor
integer | null
​
bisection_threshold
integer | null
​
column_mapping
array | null
​
columns_to_compare
string[] | null
​
data_source1_session_parameters
object | null
​
data_source2_session_parameters
object | null
​
diff_tolerance
number | null
​
diff_tolerances_per_column
object[] | null
​
download_limit
integer | null
​
exclude_columns
string[] | null
​
file1
string | null
Minimum length: 1
​
file1_options
object | null
​
file2
string | null
Minimum length: 1
​
file2_options
object | null
​
filter1
string | null
​
filter2
string | null
​
include_columns
string[] | null
​
materialization_destination_id
integer | null
​
materialize_dataset1
boolean | null
​
materialize_dataset2
boolean | null
​
materialize_without_sampling
boolean | null
default: false
​
per_column_diff_limit
integer | null
​
purged
boolean
default: false
​
query1
string | null
​
query2
string | null
​
sampling_confidence
number | null
​
sampling_ratio
number | null
​
sampling_threshold
integer | null
​
sampling_tolerance
number | null
​
table1
string[] | null
​
table2
string[] | null
​
table_modifiers
enum<string>[] | null
Available options:
case_insensitive_strings
​
tags
string[] | null
​
time_aggregate
enum<string> | null
Available options:
minute,
hour,
day,
week,
month,
year
​
time_column
string | null
​
time_interval_end
string | null
​
time_interval_start
string | null
​
time_travel_point1
​
time_travel_point2

Response

200 - application/json
​
data_source1_id
integer
required
​
data_source2_id
integer
required
​
kind
enum<string>
required
Available options:
in_db,
cross_db
​
pk_columns
string[]
required
​
affected_columns
string[] | null
​
algorithm
enum<string> | null
Available options:
join,
hash,
hash_v2_alpha,
fetch_and_join
​
archived
boolean
default: false
​
bisection_factor
integer | null
​
bisection_threshold
integer | null
​
ci_base_branch
string | null
​
ci_pr_branch
string | null
​
ci_pr_num
integer | null
​
ci_pr_sha
string | null
​
ci_pr_url
string | null
​
ci_pr_user_display_name
string | null
​
ci_pr_user_email
string | null
​
ci_pr_user_id
string | null
​
ci_pr_username
string | null
​
ci_run_id
integer | null
​
ci_sha_url
string | null
​
column_mapping
array | null
​
columns_to_compare
string[] | null
​
created_at
string | null
​
data_app_metadata
object | null
​
data_app_type
string | null
​
data_source1_session_parameters
object | null
​
data_source2_session_parameters
object | null
​
diff_stats
object | null
​
diff_tolerance
number | null
​
diff_tolerances_per_column
object[] | null
​
done
boolean | null
default: false
​
download_limit
integer | null
​
exclude_columns
string[] | null
​
execute_as_user
boolean | null
​
file1
string | null
Minimum length: 1
​
file1_options
object | null
​
file2
string | null
Minimum length: 1
​
file2_options
object | null
​
filter1
string | null
​
filter2
string | null
​
finished_at
string | null
​
id
integer | null
​
include_columns
string[] | null
​
materialization_destination_id
integer | null
​
materialize_dataset1
boolean | null
​
materialize_dataset2
boolean | null
​
materialize_without_sampling
boolean | null
default: false
​
monitor_error
object | null
​
monitor_state
enum<string> | null
Available options:
ok,
alert,
error,
learning,
checking,
created,
skipped
​
per_column_diff_limit
integer | null
​
purged
boolean
default: false
​
query1
string | null
​
query2
string | null
​
result
enum<string> | null
Available options:
error,
bad-pks,
different,
missing-pks,
identical
​
result_revisions
object
​
result_statuses
object | null
​
runtime
number | null
​
sampling_confidence
number | null
​
sampling_ratio
number | null
​
sampling_threshold
integer | null
​
sampling_tolerance
number | null
​
source
enum<string> | null
Available options:
interactive,
demo_signup,
manual,
api,
ci,
schedule,
auto
​
status
enum<string> | null
Available options:
needs_confirmation,
needs_authentication,
waiting,
processing,
done,
failed,
cancelled
​
table1
string[] | null
​
table2
string[] | null
​
table_modifiers
enum<string>[] | null
Available options:
case_insensitive_strings
​
tags
string[] | null
​
temp_schema_override
string[] | null
​
time_aggregate
enum<string> | null
Available options:
minute,
hour,
day,
week,
month,
year
​
time_column
string | null
​
time_interval_end
string | null
​
time_interval_start
string | null
​
time_travel_point1
​
time_travel_point2
​
updated_at
string | null
​
user_id
integer | null
List data diffsGet a data diff