POST
/
api
/
v1
/
monitors
/
create
/
test
curl --request POST \
  --url https://app.datafold.com/api/v1/monitors/create/test \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "connection_id": 123,
  "description": "<string>",
  "enabled": true,
  "name": "<string>",
  "notifications": [
    {
      "features": [
        "attach_csv"
      ],
      "recipients": [
        "<string>"
      ],
      "type": "email"
    }
  ],
  "query": "<string>",
  "schedule": {
    "interval": {
      "every": "<string>",
      "type": "hourly"
    }
  },
  "tags": [
    "<string>"
  ],
  "test": {
    "tables": [
      {
        "columns": [
          "<string>"
        ],
        "path": "<string>"
      }
    ],
    "type": "unique",
    "variables": {}
  }
}'
{
  "id": 123
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
connection_id
integer
required

The identifier for the data source configuration.

​
name
string
required

The name of the monitor.

​
schedule
object
required

The schedule at which the monitor runs.

​
description
string | null

The description of the monitor.

​
enabled
boolean
default:true

Indicates whether the monitor is enabled.

​
notifications
object[]

Notification configuration for the monitor.

​
query
string | null

The SQL query to be evaluated.

​
tags
string[]

Tags associated with the monitor.

​
test
object | null

Response

200
application/json
Successful Response
​
id
integer
required

Unique identifier for the monitor.