Audit Logs
Data sources
Data diffs
Explore
BI
- GETList all integrations
- POSTCreate a DBT BI integration
- PUTUpdate a DBT BI integration
- POSTCreate a Hightouch integration
- PUTUpdate a Hightouch integration
- POSTCreate a Looker integration
- PUTUpdate a Looker integration
- POSTCreate a Mode Analytics integration
- PUTUpdate a Mode Analytics integration
- POSTCreate a Power BI integration
- PUTRename a Power BI integration
- POSTCreate a Tableau integration
- PUTUpdate a Tableau integration
- GETGet an integration
- DELRemove an integration
- GETSync a BI integration
Get a data diff summary
curl --request GET \
--url https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results \
--header 'Authorization: <api-key>'
{
"dependencies": [
{
"data_source_id": 123,
"data_source_type": "<string>",
"item_type": "<string>",
"name": "<string>",
"path": [
"<string>"
],
"popularity": 123,
"primary_key": "<string>",
"query_type": "<string>",
"raw_sql": "<string>",
"remote_id": "<string>",
"table_name": "<string>",
"uid": "<string>"
}
],
"materialized_results": {
"diff": [
{
"data_source_id": 123,
"is_sampled": true,
"path": [
"<string>"
]
}
],
"duplicates1": [
{
"data_source_id": 123,
"is_sampled": true,
"path": [
"<string>"
]
}
],
"duplicates2": [
{
"data_source_id": 123,
"is_sampled": true,
"path": [
"<string>"
]
}
],
"exclusives": [
{
"data_source_id": 123,
"is_sampled": true,
"path": [
"<string>"
]
}
]
},
"pks": {
"distincts": [
"<any>"
],
"dupes": [
"<any>"
],
"exclusives": [
"<any>"
],
"nulls": [
"<any>"
],
"total_rows": [
"<any>"
]
},
"schema": {
"column_counts": [
"<any>"
],
"column_reorders": 123,
"column_type_differs": [
"<string>"
],
"column_type_mismatches": 123,
"columns_mismatched": [
"<any>"
],
"exclusive_columns": [
[
"<string>"
]
]
},
"status": "done",
"values": {
"columns_diff_stats": [
{}
],
"columns_with_differences": 123,
"compared_columns": 123,
"rows_with_differences": 123,
"total_rows": 123,
"total_values": 123,
"values_with_differences": 123
}
}
Authorizations
Use the 'Authorization' header with the format 'Key <api-key>'
Path Parameters
Response
Results of the diff, materialized into tables.
Results of row-to-row comparison between dataset A and B. Semantics is the same as for exclusive_pks1
field.
Rows with duplicate primary keys detected in dataset A. Semantics is the same as for exclusive_pks1
field.
Rows with duplicate primary keys detected in dataset B. Semantics is the same as for exclusive_pks1
field.
Rows with exclusive primary keys detected in dataset A and B. None
if table is not ready yet or if materialization wasn't requested. If materialization is completed, for a diff inside a single database the field will contain a list with one element. If diff compares tables in different databases, the list may contain one or two entries.
done
, success
curl --request GET \
--url https://app.datafold.com/api/v1/datadiffs/{datadiff_id}/summary_results \
--header 'Authorization: <api-key>'
{
"dependencies": [
{
"data_source_id": 123,
"data_source_type": "<string>",
"item_type": "<string>",
"name": "<string>",
"path": [
"<string>"
],
"popularity": 123,
"primary_key": "<string>",
"query_type": "<string>",
"raw_sql": "<string>",
"remote_id": "<string>",
"table_name": "<string>",
"uid": "<string>"
}
],
"materialized_results": {
"diff": [
{
"data_source_id": 123,
"is_sampled": true,
"path": [
"<string>"
]
}
],
"duplicates1": [
{
"data_source_id": 123,
"is_sampled": true,
"path": [
"<string>"
]
}
],
"duplicates2": [
{
"data_source_id": 123,
"is_sampled": true,
"path": [
"<string>"
]
}
],
"exclusives": [
{
"data_source_id": 123,
"is_sampled": true,
"path": [
"<string>"
]
}
]
},
"pks": {
"distincts": [
"<any>"
],
"dupes": [
"<any>"
],
"exclusives": [
"<any>"
],
"nulls": [
"<any>"
],
"total_rows": [
"<any>"
]
},
"schema": {
"column_counts": [
"<any>"
],
"column_reorders": 123,
"column_type_differs": [
"<string>"
],
"column_type_mismatches": 123,
"columns_mismatched": [
"<any>"
],
"exclusive_columns": [
[
"<string>"
]
]
},
"status": "done",
"values": {
"columns_diff_stats": [
{}
],
"columns_with_differences": 123,
"compared_columns": 123,
"rows_with_differences": 123,
"total_rows": 123,
"total_values": 123,
"values_with_differences": 123
}
}