Skip to main content

data_observability_monitor_run_statuses

Creates, updates, deletes, gets or lists a data_observability_monitor_run_statuses resource.

Overview

Namedata_observability_monitor_run_statuses
TypeResource
Iddatadog.monitoring.data_observability_monitor_run_statuses

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringThe unique identifier of the monitor run. (example: abc123def456)
attributesobjectThe attributes of a data observability monitor run status response.
typestringThe JSON:API resource type for a data observability monitor run. (monitor_run) (default: monitor_run, example: monitor_run)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_data_observability_monitor_run_statusselectrun_idRetrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
run_idstringThe ID of the monitor run to retrieve status for. (example: abc123def456)
sitestringThe Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

SELECT examples

Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.

SELECT
id,
attributes,
type
FROM datadog.monitoring.data_observability_monitor_run_statuses
WHERE run_id = '{{ run_id }}' -- required
;