GET
/
api
/
v1
/
datadiffs
curl --request GET \
  --url https://app.datafold.com/api/v1/datadiffs \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "page": 123,
  "page_size": 123,
  "results": [
    {
      "affected_columns": [
        "<string>"
      ],
      "algorithm": "join",
      "archived": false,
      "bisection_factor": 123,
      "bisection_threshold": 123,
      "ci_base_branch": "<string>",
      "ci_pr_branch": "<string>",
      "ci_pr_num": 123,
      "ci_pr_sha": "<string>",
      "ci_pr_url": "<string>",
      "ci_pr_user_display_name": "<string>",
      "ci_pr_user_email": "<string>",
      "ci_pr_user_id": "<string>",
      "ci_pr_username": "<string>",
      "ci_run_id": 123,
      "ci_sha_url": "<string>",
      "column_mapping": [
        [
          "<any>"
        ]
      ],
      "columns_to_compare": [
        "<string>"
      ],
      "compare_duplicates": true,
      "created_at": "2023-11-07T05:31:56Z",
      "data_app_metadata": {
        "data_app_id": 123,
        "data_app_model1_id": "<string>",
        "data_app_model1_name": "<string>",
        "data_app_model2_id": "<string>",
        "data_app_model2_name": "<string>",
        "data_app_model_type": "<string>",
        "meta_data": {}
      },
      "data_app_type": "<string>",
      "data_source1_id": 123,
      "data_source1_session_parameters": {},
      "data_source2_id": 123,
      "data_source2_session_parameters": {},
      "diff_stats": {
        "diff_duplicate_pks": 123,
        "diff_null_pks": 123,
        "diff_pks": 123,
        "diff_rows": 123,
        "diff_rows_count": 123,
        "diff_rows_number": 123,
        "diff_schema": 123,
        "diff_values": 123,
        "errors": 123,
        "rows_added": 123,
        "rows_removed": 123,
        "sampled": true,
        "table_a_row_count": 123,
        "table_b_row_count": 123,
        "version": "<string>"
      },
      "diff_tolerance": 123,
      "diff_tolerances_per_column": [
        {
          "column_name": "<string>",
          "tolerance_mode": "absolute",
          "tolerance_value": 123
        }
      ],
      "done": true,
      "download_limit": 123,
      "exclude_columns": [
        "<string>"
      ],
      "execute_as_user": true,
      "file1": "<string>",
      "file1_options": {
        "delimiter": "<string>",
        "file_type": "csv",
        "skip_head_rows": 123,
        "skip_tail_rows": 123
      },
      "file2": "<string>",
      "file2_options": {
        "delimiter": "<string>",
        "file_type": "<string>",
        "skip_head_rows": 123,
        "skip_tail_rows": 123
      },
      "filter1": "<string>",
      "filter2": "<string>",
      "finished_at": "2023-11-07T05:31:56Z",
      "id": 123,
      "include_columns": [
        "<string>"
      ],
      "kind": "in_db",
      "materialization_destination_id": 123,
      "materialize_dataset1": true,
      "materialize_dataset2": true,
      "materialize_without_sampling": true,
      "monitor_error": {
        "error_type": "<string>",
        "error_value": "<string>"
      },
      "monitor_id": 123,
      "monitor_state": "ok",
      "per_column_diff_limit": 123,
      "pk_columns": [
        "<string>"
      ],
      "purged": false,
      "query1": "<string>",
      "query2": "<string>",
      "result": "error",
      "result_revisions": {},
      "result_statuses": {},
      "runtime": 123,
      "sampling_confidence": 123,
      "sampling_ratio": 123,
      "sampling_threshold": 123,
      "sampling_tolerance": 123,
      "source": "interactive",
      "status": "needs_confirmation",
      "table1": [
        "<string>"
      ],
      "table2": [
        "<string>"
      ],
      "table_modifiers": [
        "case_insensitive_strings"
      ],
      "tags": [
        "<string>"
      ],
      "temp_schema_override": [
        "<string>"
      ],
      "time_aggregate": "minute",
      "time_column": "<string>",
      "time_interval_end": "2023-11-07T05:31:56Z",
      "time_interval_start": "2023-11-07T05:31:56Z",
      "time_travel_point1": 123,
      "time_travel_point2": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "user_id": 123
    }
  ],
  "total_pages": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:1
​
page_size
integer
default:100
​
sort_order
enum<string>
Available options:
asc,
desc
​
order_by
enum<string>
Available options:
id,
user_id,
user_name,
data_source1_id,
data_source2_id,
table1,
table2,
query1,
query2,
pk_columns,
include_columns,
exclude_columns,
time_column,
time_aggregate,
filter1,
filter2,
done,
time_interval_start,
time_interval_end,
created_at,
updated_at,
diff_stats_pks,
diff_stats_rows,
diff_stats_values,
tags,
source,
status,
bisection_factor,
bisection_threshold,
ci_type,
ci_run_id,
pr_user_id,
pr_username,
pr_user_email,
pr_user_display_name,
pr_num,
pr_branch,
monitor_id,
data_app_type,
data_app_data_source_id,
data_app_model1_id,
data_app_model2_id,
data_app_model1_name,
data_app_model2_name,
user_ref,
result,
archived,
purged,
kind

Response

200
application/json
Successful Response
​
count
integer
required
​
page
integer
required
​
page_size
integer
required
​
results
object[]
required
​
total_pages
integer
required