PATCH
/
api
/
v1
/
monitors
/
{id}
/
update
curl --request PATCH \
  --url https://app.datafold.com/api/v1/monitors/{id}/update \
  --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>"
    ],
    "diff_type": "indb",
    "ignore_string_case": true,
    "materialize_results": true,
    "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>",
  "name": "<string>",
  "notifications": [
    {
      "features": [
        "attach_csv"
      ],
      "recipients": [
        "<string>"
      ],
      "type": "email"
    }
  ],
  "schedule": {
    "interval": {
      "every": "<string>",
      "type": "<string>"
    }
  },
  "tags": [
    "<string>"
  ],
  "type": "<string>"
}'
"<any>"

Authorizations

​
Authorization
string
header
required

Use the 'Authorization' header with the format 'Key <api-key>'

Path Parameters

​
id
integer
required

The unique identifier of the monitor.

Body

application/json
​
type
string
required

The type of monitor.

Allowed value: "diff"
​
alert
object | null

Condition for triggering alerts based on the data diff.

​
datadiff
object | null

Configuration for the data diff.

​
description
string | null

The description of the monitor.

​
name
string | null

The name of the monitor.

​
notifications
object[]

Notification configuration for the monitor.

​
schedule
object | null

The schedule at which the monitor runs.

​
tags
string[]

Tags associated with the monitor.

Response

200
application/json
Successful Response

The response is of type any.