Skip to main content

List data diffs

GET 
/api/v1/datadiffs

All fields support multiple items, using just comma delimiter Date fields also support ranges using the following syntax:

  • <DATETIME = before DATETIME
  • >DATETIME = after DATETIME
  • DATETIME = between DATETIME and DATETIME + 1 MINUTE
  • DATE = start of that DATE until DATE + 1 DAY
  • DATETIME1<<DATETIME2 = between DATETIME1 and DATETIME2
  • DATE1<<DATE2 = between DATE1 and DATE2

Request​

Query Parameters

    page Page

    Default value: 1

    page_size Page Size

    Default value: 100

    sort_order any
    order_by any

Responses​

Successful Response

Schema
    count Countrequired
    page Pagerequired
    page_size Page Sizerequired
    results object[]required
  • Array [
    • affected_columns string[]
    algorithm DiffAlgorithm

    Possible values: [join, hash, hash_v2_alpha]

    An enumeration.

    archived Archived

    Default value: false

    bisection_factor Bisection Factor
    bisection_threshold Bisection Threshold
    ci_base_branch Ci Base Branch
    ci_pr_branch Ci Pr Branch
    ci_pr_num Ci Pr Num
    ci_pr_sha Ci Pr Sha
    ci_pr_url Ci Pr Url
    ci_pr_user_display_name Ci Pr User Display Name
    ci_pr_user_email Ci Pr User Email
    ci_pr_user_id Ci Pr User Id
    ci_pr_username Ci Pr Username
    ci_run_id Ci Run Id
    ci_sha_url Ci Sha Url
    column_mapping array[]

    Possible values: >= 2, <= 2

    columns_to_compare string[]
    created_at date-time
    data_app_metadata object
    data_app_id Data App Idrequired
    data_app_model1_id Data App Model1 Id
    data_app_model1_name Data App Model1 Name
    data_app_model2_id Data App Model2 Id
    data_app_model2_name Data App Model2 Name
    data_app_model_type Data App Model Typerequired
    meta_data objectrequired
    data_app_type Data App Type
    data_source1_id Data Source1 Idrequired
    data_source1_session_parameters object
    data_source2_id Data Source2 Idrequired
    data_source2_session_parameters object
    diff_stats object
    diff_duplicate_pks Diff Duplicate Pks
    diff_null_pks Diff Null Pks
    diff_pks Diff Pks
    diff_rows Diff Rows
    diff_rows_count Diff Rows Count
    diff_rows_number Diff Rows Number
    diff_schema Diff Schema
    diff_values Diff Values
    errors Errors
    rows_added Rows Added
    rows_removed Rows Removed
    sampled Sampled
    table_a_row_count Table A Row Count
    table_b_row_count Table B Row Count
    version Versionrequired
    diff_tolerance Diff Tolerance
    diff_tolerances_per_column object[]
  • Array [
    • column_name Column Namerequired
    tolerance_mode ToleranceModeEnumrequired

    Possible values: [absolute, relative]

    An enumeration.

    tolerance_value Tolerance Valuerequired
  • ]
    • done Done

    Default value: false

    download_limit Download Limit
    exclude_columns string[]
    execute_as_user Execute As User
    filter1 Filter1
    filter2 Filter2
    finished_at date-time
    id Id
    include_columns string[]
    kind DiffKindrequired

    Possible values: [in_db, cross_db]

    An enumeration.

    materialization_destination_id Materialization Destination Id
    materialize_dataset1 Materialize Dataset1
    materialize_dataset2 Materialize Dataset2
    materialize_without_sampling Materialize Without Sampling

    Default value: false

    per_column_diff_limit Per Column Diff Limit
    pk_columns string[]required
    purged Purged

    Default value: false

    query1 Query1
    query2 Query2
    result Result

    Possible values: [error, bad-pks, different, missing-pks, identical]

    result_revisions object
    property name* integer
    result_statuses object
    property name* string
    runtime time-delta
    sampling_confidence Sampling Confidence
    sampling_threshold Sampling Threshold
    sampling_tolerance Sampling Tolerance
    source JobSource

    Possible values: [interactive, demo_signup, manual, api, ci, schedule, auto]

    An enumeration.

    status JobStatus

    Possible values: [needs_confirmation, needs_authentication, waiting, processing, done, failed, cancelled]

    An enumeration.

    table1 string[]
    table2 string[]
    tags string[]
    temp_schema_override string[]
    time_aggregate TimeAggregateEnum

    Possible values: [minute, hour, day, week, month, year]

    An enumeration.

    time_column Time Column
    time_interval_end date-time
    time_interval_start date-time
    time_travel_point1 object
    anyOf

    integer

    time_travel_point2 object
    anyOf

    integer

    updated_at date-time
    user_id User Id
  • ]
    • total_pages Total Pagesrequired
Loading...