Skip to main content
GET
/
api
/
v1
/
monitors
/
{id}
Get Monitor
curl --request GET \
  --url https://app.datafold.com/api/v1/monitors/{id} \
  --header 'Authorization: <api-key>'
{
  "alert": {
    "different_rows_count": 123,
    "different_rows_percent": 123,
    "type": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "dataset": [
    {
      "column": "<string>",
      "connection_id": 123,
      "filter": "<string>",
      "metric": "<string>",
      "query": "<string>",
      "table": "<string>"
    }
  ],
  "description": "<string>",
  "enabled": true,
  "id": 123,
  "last_alert": "2023-11-07T05:31:56Z",
  "last_run": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "monitor_type": "diff",
  "name": "<string>",
  "notifications": [
    {
      "features": [
        "attach_csv"
      ],
      "recipients": [
        "<string>"
      ],
      "type": "email"
    }
  ],
  "schedule": {
    "interval": {
      "every": "<string>",
      "type": "hourly"
    }
  },
  "state": "ok",
  "tags": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Path Parameters

id
integer
required

Response

created_at
string<date-time>
required
enabled
boolean
required
id
integer
required
modified_at
string<date-time>
required
monitor_type
enum<string> | null
required
Available options:
diff,
metric,
schema,
test
name
string | null
required
schedule
object
required
  • Interval
  • Cron
  • None
alert
object | null
  • Diff Conditions
  • Anomaly Detection
  • Absolute
  • Percentage
dataset
MonitorDataset · object[]
description
string | null
last_alert
string<date-time> | null
last_run
string<date-time> | null
notifications
Notifications · array
  • Email
  • PagerDuty
  • Webhook
  • Slack
  • Teams
state
enum<string> | null
Available options:
ok,
alert,
error,
learning,
checking,
created,
skipped,
cancelled
tags
string[] | null