Skip to main content
GET
/
api
/
v1
/
datadiffs
/
{datadiff_id}
/
summary
Get a human-readable summary of a DataDiff comparison
curl --request GET \
  --url https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary \
  --header 'Authorization: <api-key>'
{
  "data_source1_id": 123,
  "data_source2_id": 123,
  "id": 123,
  "status": "needs_confirmation",
  "algorithm": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "data_source1_name": "<string>",
  "data_source2_name": "<string>",
  "diff_stats": {},
  "error": "<string>",
  "feedback": "<string>",
  "finished_at": "2023-11-07T05:31:56Z",
  "include_columns": [
    "<string>"
  ],
  "pk_columns": [
    "<string>"
  ],
  "result": "<string>",
  "result_status": "<string>",
  "results_count": 0,
  "sampling_ratio": 123,
  "table1": [
    "<string>"
  ],
  "table2": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
datadiff_id
integer
required

Response

Successful Response

Summary of a DataDiff comparison with human-readable feedback.

​
data_source1_id
integer
required
​
data_source2_id
integer
required
​
id
integer
required
​
status
enum<string>
required
Available options:
needs_confirmation,
needs_authentication,
waiting,
processing,
done,
failed,
cancelled
​
algorithm
string | null
​
created_at
string<date-time> | null
​
data_source1_name
string | null
​
data_source2_name
string | null
​
diff_stats
Diff Stats · object
​
error
string | null
​
feedback
string | null
​
finished_at
string<date-time> | null
​
include_columns
string[] | null
​
pk_columns
string[] | null
​
result
string | null
​
result_status
string | null
​
results_count
integer
default:0
​
sampling_ratio
number | null
​
table1
string[] | null
​
table2
string[] | null