data_observability_monitor_run_statuses
Creates, updates, deletes, gets or lists a data_observability_monitor_run_statuses resource.
Overview
| Name | data_observability_monitor_run_statuses |
| Type | Resource |
| Id | datadog.monitoring.data_observability_monitor_run_statuses |
Fields
The following fields are returned by SELECT queries:
- get_data_observability_monitor_run_status
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the monitor run. (example: abc123def456) |
attributes | object | The attributes of a data observability monitor run status response. |
type | string | The 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:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_data_observability_monitor_run_status | select | run_id | Retrieves 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.
| Name | Datatype | Description |
|---|---|---|
run_id | string | The ID of the monitor run to retrieve status for. (example: abc123def456) |
site | string | The 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
- get_data_observability_monitor_run_status
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
;