GET
/
api
/
v1
/
monitors
/
{id}
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": [
    {
      "recipients": [
        "<string>"
      ],
      "type": "<string>"
    }
  ],
  "schedule": {
    "interval": {
      "every": "<string>",
      "type": "hourly"
    }
  },
  "state": "ok",
  "tags": [
    "<string>"
  ]
}

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.

Response

200
application/json
Successful Response
​
created_at
string
required

Timestamp when the monitor was created.

​
enabled
boolean
required

Indicates whether the monitor is enabled.

​
id
integer
required

Unique identifier for the monitor.

​
modified_at
string
required

Timestamp when the monitor was last modified.

​
monitor_type
enum<string> | null
required

Type of the monitor.

Available options:
diff,
metric,
schema,
test
​
name
string | null
required

Name of the monitor.

​
schedule
object
required

The schedule at which the monitor runs.

​
alert
object | null

Condition for triggering alerts based on the data diff.

​
dataset
object[]

Dataset configuration for the monitor.

​
description
string | null

The description of the monitor.

​
last_alert
string | null

Timestamp of the last alert.

​
last_run
string | null

Timestamp of the last monitor run.

​
notifications
object[]

Notification configuration for the monitor.

​
state
enum<string> | null

Current state of the monitor run.

Available options:
ok,
alert,
error,
learning,
checking,
created,
skipped,
cancelled
​
tags
string[] | null

Tags associated with the monitor.

Create a Data Test MonitorDelete a Monitor