How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Datafold Data diffs API

The Data diffs API from Datafold — 5 operation(s) for data diffs.

Datafold Data diffs API is one of 13 APIs that Datafold publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data diffs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 7 operations across 5 paths, and defines 47 schemas. It is described by OpenAPI 3.1.0, at version latest.

Requests are made against a single base URL, https://app.datafold.com.

7 operations 5 paths 47 schemas 4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
latest
Base URL
https://app.datafold.com/api/v1/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Datafold Data diffs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Use the 'Authorization' header with the format 'Key '

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Data diffs 7
GET
/api/v1/datadiffs
List data diffs
list_datadiffs_api_v1_datadiffs_get 5 params → 200422
POST
/api/v1/datadiffs
Create a data diff
create_datadiff_api_v1_datadiffs_post body → 200422
GET
/api/v1/datadiffs/{datadiff_id}
Get a data diff
get_datadiff_api_v1_datadiffs__datadiff_id__get 2 params → 200422
PATCH
/api/v1/datadiffs/{datadiff_id}
Update a data diff
update_datadiff_api_v1_datadiffs__datadiff_id__patch 1 param body → 200422
POST
/api/v1/datadiffs/{datadiff_id}/cancel
Cancel a running data diff
cancel_diff_api_v1_datadiffs__datadiff_id__cancel_post 1 param → 200422
GET
/api/v1/datadiffs/{datadiff_id}/summary
Get a human-readable summary of a DataDiff comparison
get_diff_summary_api_v1_datadiffs__datadiff_id__summary_get 1 param → 200422
GET
/api/v1/datadiffs/{datadiff_id}/summary_results
Get a data diff summary
get_diff_summary_v1_api_v1_datadiffs__datadiff_id__summary_results_get 1 param → 200422

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are ApiDataDiffWithProgressState (90 properties), ApiDataDiffFull (89 properties), ApiDataDiffData (53 properties), ApiDataDiffSummary (20 properties). Each schema is shown below with its type and property counts.

TableModifiers
string
ApiDataDiffCancelled
object
2 properties 2 required
ValidationError
object
3 properties 3 required
ApiCrossDataDiffSummaryForDone
object
3 properties 1 required
ApiColumnDiffStat
object
4 properties 3 required
TDataDiffDataAppMetadata
object
7 properties 3 required
HTTPValidationError
object
1 property
ApiDataDiffFull
object
89 properties 4 required
ApiDataDiffSummary
object
Summary of a DataDiff comparison with human-readable feedback.
20 properties 4 required
ParquetFileOptions
object
1 property
ApiMaterializedResults
object
4 properties
JobSource
string
CSVFileOptions
object
4 properties
ApiDataDiffSummarySchema
object
6 properties 6 required
ApiColumnRule
object
3 properties 1 required
ApiDataDiffSummaryForRunning
object
1 property 1 required
InternalApiDataDiffDependencies
object
2 properties 2 required
ExcelFileOptions
object
4 properties
ApiDataDiffError
object
3 properties 2 required
ToleranceModeEnum
string
DiffAlgorithm
string
TimeAggregateEnum
string
ApiColumnProfileStats
object
7 properties 2 required
MonitorRunState
string
QueryError
object
2 properties 2 required
DatatypeName
string
ApiDataDiffPage
object
5 properties 5 required
ApiEstimatedIntValue
object
4 properties 4 required
ApiTableProfile
object
Profile statistics for exclusive rows in one table.
1 property 1 required
ApiDataDiffSummaryPKs
object
5 properties 5 required
ApiDataDiffSummaryForFailed
object
2 properties 2 required
JobStatus
string
DiffProgress
object
3 properties 1 required
DiffStats
object
16 properties 1 required
ColumnTolerance
object
3 properties 3 required
ApiCIDependency
object
12 properties 6 required
ApiDataDiffSummaryForDone
object
7 properties 5 required
ApiSortFilters
string
ApiDataDiffData
object
53 properties 2 required
Body_update_datadiff_api_v1_datadiffs__datadiff_id__patch
object
2 properties
DiffKind
string
ApiSortOrder
string
ApiDataDiffSummaryValues
object
7 properties 7 required
ApiEstimatedIntInterval
object
2 properties 2 required
ApiExclusiveRowsProfile
object
2 properties
ApiDataDiffWithProgressState
object
90 properties 4 required
ApiMaterializedResult
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datafold-data-diffs-api-openapi.yml Raw ↑

Other APIs Datafold publishes across the network.

Datafold Audit Logs API
Datafold bi_added API
Datafold BI API
Datafold bi_deleted API
Datafold bi_modified API
Datafold bolt API
Datafold CI API
Datafold data_source_added API
Datafold Data sources API
Datafold diff_created API
Datafold Explore API
Datafold Monitors API
Where this information came from

This is an independent, third-party profile of Datafold Data diffs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.