GET
/
api
/
v1
/
monitors
/
{id}
/
runs
/
{run_id}
Get Monitor Run
curl --request GET \
  --url https://app.datafold.com/api/v1/monitors/{id}/runs/{run_id} \
  --header 'Authorization: <api-key>'
{
  "diff_id": 123,
  "error": "<string>",
  "monitor_id": 123,
  "run_id": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "state": "ok",
  "warnings": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
run_id
integer
required

The unique identifier of the run to retrieve.

​
id
integer
required

The unique identifier of the monitor associated with the run.

Response

Successful Response

​
monitor_id
integer
required

Unique identifier for the associated monitor.

​
run_id
integer
required

Unique identifier for the monitor run result.

​
state
enum<string>
required

Current state of the monitor run result.

Available options:
ok,
alert,
error,
learning,
checking,
created,
skipped,
cancelled
​
warnings
string[]
required

List of warning messages generated during the run.

​
diff_id
integer | null

Unique identifier for the associated datadiff.

​
error
string | null

Error message if the run encountered an error.

​
started_at
string<date-time> | null

Timestamp when the monitor run started.