Get data observability monitor run status
WARNINGNote: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
GET
https://api.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.us3.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.us5.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.datadoghq.eu/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.ap1.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.ap2.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.uk1.datadoghq.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.ddog-gov.com/api/v2/data-observability/monitors/runs/{run_id}/statushttps://api.us2.ddog-gov.com/api/v2/data-observability/monitors/runs/{run_id}/statusOverview
Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.
OAuth apps require the data_observability_monitors_write, monitors_write authorization scope to access this endpoint.
Arguments
Path Parameters
Name
Type
Description
run_id [required]string
The ID of the monitor run to retrieve status for.
Response
OK
The response for getting the status of a data observability monitor run.
Field
Type
Description
data [required]object
The data object for a data observability monitor run status response.
attributes [required]object
The attributes of a data observability monitor run status response.
error_messagestring
Error message describing why the monitor run failed. Only present when status is error.
status [required]enum
The status of a data observability monitor run.
Allowed enum values:
pending, ok, warn, alert, errorid [required]string
The unique identifier of the monitor run.
type [required]enum
The JSON:API resource type for a data observability monitor run.
monitor_runAllowed enum values:
monitor_run{
"data": {
"attributes": {
"error_message": "run completed but produced no metric data",
"status": "pending"
},
"id": "abc123def456",
"type": "monitor_run"
}
}Not Found
API error response.
Field
Type
Description
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
Get data observability monitor run status
# Path parameters
export run_id="abc123def456"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export run_id="abc123def456"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export run_id="abc123def456"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export run_id="abc123def456"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export run_id="abc123def456"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export run_id="abc123def456"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export run_id="abc123def456"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export run_id="abc123def456"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"# Path parameters
export run_id="abc123def456"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X GET "https://api.${DD_SITE}/api/v2/data-observability/monitors/runs/${run_id}/status" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"