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
Create a Data Diff Monitor
curl --request POST \
--url https://app.datafold.com/api/v1/monitors/create/diff \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"alert": {
"different_rows_count": 123,
"different_rows_percent": 123
},
"datadiff": {
"column_remapping": {},
"columns_to_compare": [
"<string>"
],
"dataset_a": {
"connection_id": 123,
"filter": "<string>",
"session_parameters": {},
"table": "<string>",
"time_travel_point": "<string>"
},
"dataset_b": {
"connection_id": 123,
"filter": "<string>",
"session_parameters": {},
"table": "<string>",
"time_travel_point": "<string>"
},
"ignore_string_case": false,
"materialize_results": false,
"primary_key": [
"<string>"
],
"sampling": {
"confidence": 123,
"threshold": 123,
"tolerance": 123
},
"timeseries_dimension_column": "<string>",
"tolerance": {
"float": {
"column_tolerance": {},
"default": {
"type": "<string>",
"value": 123
}
}
}
},
"description": "<string>",
"enabled": true,
"name": "<string>",
"notifications": [
{
"features": [
"attach_csv"
],
"recipients": [
"<string>"
],
"type": "email"
}
],
"schedule": {
"interval": {
"every": "<string>",
"type": "hourly"
}
},
"tags": [
"<string>"
]
}'{
"id": 123
}Authorizations
Use the 'Authorization' header with the format 'Key <api-key>'
Body
Configuration for the data diff.
The first dataset to compare.
The identifier for the data source configuration.
The table in the format 'db.schema.table'.
Filter condition for querying the dataset.
Session parameters for the database session.
Point in time for querying historical data.
The second dataset to compare.
The identifier for the data source configuration.
The table in the format 'db.schema.table'.
Filter condition for querying the dataset.
Session parameters for the database session.
Point in time for querying historical data.
List of columns that make up the primary key for the datasets.
Mapping of columns from one dataset to another for comparison.
Optional list of columns to compare between the datasets.
Indicates whether to ignore case differences in string comparisons.
Indicates whether to materialize the results of the comparison.
Sampling configuration for the data comparison.
Column used for time series dimensioning in the comparison.
Configuration for tolerance.
Configuration for float columns tolerance.
Specific tolerance per column.
The name of the monitor.
The description of the monitor.
Indicates whether the monitor is enabled.
Notification configuration for the monitor.
A list of email addresses to receive the notification.
A list of features to enable for this notification.
attach_csv, notify_first_triggered_only "email"Tags associated with the monitor.
Response
Unique identifier for the monitor.
curl --request POST \
--url https://app.datafold.com/api/v1/monitors/create/diff \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"alert": {
"different_rows_count": 123,
"different_rows_percent": 123
},
"datadiff": {
"column_remapping": {},
"columns_to_compare": [
"<string>"
],
"dataset_a": {
"connection_id": 123,
"filter": "<string>",
"session_parameters": {},
"table": "<string>",
"time_travel_point": "<string>"
},
"dataset_b": {
"connection_id": 123,
"filter": "<string>",
"session_parameters": {},
"table": "<string>",
"time_travel_point": "<string>"
},
"ignore_string_case": false,
"materialize_results": false,
"primary_key": [
"<string>"
],
"sampling": {
"confidence": 123,
"threshold": 123,
"tolerance": 123
},
"timeseries_dimension_column": "<string>",
"tolerance": {
"float": {
"column_tolerance": {},
"default": {
"type": "<string>",
"value": 123
}
}
}
},
"description": "<string>",
"enabled": true,
"name": "<string>",
"notifications": [
{
"features": [
"attach_csv"
],
"recipients": [
"<string>"
],
"type": "email"
}
],
"schedule": {
"interval": {
"every": "<string>",
"type": "hourly"
}
},
"tags": [
"<string>"
]
}'{
"id": 123
}