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 Monitors API

The Monitors API from Datafold — 11 operation(s) for monitors.

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

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

This API exposes 12 operations across 11 paths, and defines 65 schemas. It is described by OpenAPI 3.1.0, at version latest.

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

12 operations 11 paths 65 schemas 1 DELETE4 GET1 PATCH5 POST1 PUT

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 Monitors 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 12

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

Monitors 12
GET
/api/v1/monitors
List Monitors
list_monitors_api_v1_monitors_get 5 params → 200422
POST
/api/v1/monitors/create/diff
Create a Data Diff Monitor
create_monitor_diff_api_v1_monitors_create_diff_post body → 200422
POST
/api/v1/monitors/create/metric
Create a Metric Monitor
create_monitor_metric_api_v1_monitors_create_metric_post body → 200422
POST
/api/v1/monitors/create/schema
Create a Schema Change Monitor
create_monitor_schema_api_v1_monitors_create_schema_post body → 200422
POST
/api/v1/monitors/create/test
Create a Data Test Monitor
create_monitor_test_api_v1_monitors_create_test_post body → 200422
DELETE
/api/v1/monitors/{id}
Delete a Monitor
delete_monitor_api_v1_monitors__id__delete 1 param → 200422
GET
/api/v1/monitors/{id}
Get Monitor
get_monitor_api_v1_monitors__id__get 1 param → 200422
POST
/api/v1/monitors/{id}/run
Trigger a run
start_monitor_run_api_v1_monitors__id__run_post 1 param → 200422
GET
/api/v1/monitors/{id}/runs
List Monitor Runs
list_monitor_runs_api_v1_monitors__id__runs_get 5 params → 200422
GET
/api/v1/monitors/{id}/runs/{run_id}
Get Monitor Run
get_monitor_run_api_v1_monitors__id__runs__run_id__get 2 params → 200422
PUT
/api/v1/monitors/{id}/toggle
Toggle a Monitor
toggle_monitor_on_off_api_v1_monitors__id__toggle_put 1 param body → 200422
PATCH
/api/v1/monitors/{id}/update
Update a Monitor
update_monitor_api_v1_monitors__id__update_patch 1 param body → 200422

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are InMemDataDiffConfig (16 properties), ApiPublicGetMonitorOutFull (16 properties), InDbDataDiffConfig (15 properties), InMemUpdateDataDiffConfig (12 properties). Each schema is shown below with its type and property counts.

CustomMetricMonitorConfig
object
3 properties 1 required
SDTVariable
object
2 properties 1 required
datafold__monitors__schemas__DiffAlertCondition
object
3 properties
ApiPublicListMonitorRunsOut
object
5 properties 5 required
ValidationError
object
3 properties 3 required
ApiPublicMonitorRunResultOut
object
7 properties 4 required
ColumnMetricAlias
string
InMemDataDiffConfig
object
16 properties 3 required
HTTPValidationError
object
1 property
HourIntervalSchedule
object
2 properties 1 required
EmailNotification
object
3 properties 1 required
BaseTableMetricMonitorConfig
object
4 properties 1 required
XdbQueryDataset
object
4 properties 2 required
MetricUpdateMonitorSpecPublic
object
8 properties 1 required
PagerDutyNotification
object
3 properties 1 required
AnomalyDetectionThreshold
object
2 properties 2 required
ApiPublicGetMonitorOut
object
11 properties 6 required
AbsoluteThreshold
object
3 properties 1 required
NoneSchedule
object
1 property
ApiPublicCreateMonitorOut
object
1 property 1 required
DataDiffUpdateMonitorSpecPublic
object
9 properties 1 required
PercentageSampling
object
2 properties 1 required
Body_toggle_monitor_on_off_api_v1_monitors__id__toggle_put
object
1 property 1 required
ToleranceBasedSampling
object
3 properties 2 required
InDbTableDataset
object
5 properties 2 required
ApiPublicGetMonitorOutFull
object
16 properties 7 required
MonitorDataset
object
6 properties 1 required
AbsoluteColumnTolerance
object
2 properties 1 required
DataDiffToleranceConfig
object
2 properties
StandardDataTestMonitorSpec
object
3 properties 1 required
InDbDataDiffConfig
object
15 properties 3 required
DayIntervalSchedule
object
4 properties 1 required
MonitorRunState
string
IntervalSchedule
object
1 property 1 required
MetricMonitorSpecPublic
object
10 properties 4 required
RelativeColumnTolerance
object
2 properties 1 required
SDTTable
object
2 properties 2 required
SchemaChangeMonitorSpecPublic
object
9 properties 3 required
SlackNotification
object
5 properties 2 required
ApiPublicMonitorTriggerRunResultOut
object
1 property 1 required
DataTestMonitorSpecPublic
object
10 properties 3 required
InDbUpdateDataDiffConfig
object
11 properties
DatatypeName
string
ColumnMetricMonitorConfig
object
5 properties 3 required
ApiPublicMonitorRunOut
object
5 properties 2 required
DataTestUpdateMonitorSpecPublic
object
9 properties 1 required
TableMetricAlias
string
CronSchedule
object
2 properties 1 required
PercentageThreshold
object
3 properties 1 required
SortableFields
string
DatetimeColumnToleranceConfig
object
1 property 1 required
DestinationFeatures
string
ColumnRule
object
3 properties 1 required
datafold__api__v1__monitors__DiffAlertCondition
object
4 properties 1 required
TeamsNotification
object
5 properties 2 required
InDbQueryDataset
object
4 properties 2 required
InMemUpdateDataDiffConfig
object
12 properties
SchemaChangeUpdateMonitorSpecPublic
object
7 properties 1 required
MaxRowsSampling
object
2 properties 1 required
ColumnToleranceConfig
object
2 properties
StandardDataTestTypes
string
ApiPublicListMonitorsOut
object
5 properties 5 required
WebhookNotification
object
3 properties 1 required
DataDiffMonitorSpecPublic
object
9 properties 3 required
XdbTableDataset
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datafold-monitors-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 diffs API
Datafold data_source_added API
Datafold Data sources API
Datafold diff_created API
Datafold Explore API
Where this information came from

This is an independent, third-party profile of Datafold Monitors 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.