@@ -28735,6 +28735,31 @@ components:
2873528735 - bucket_name
2873628736 - bucket_region
2873728737 type: object
28738+ DataObservabilityMonitorRunStatus:
28739+ description: The status of a data observability monitor run.
28740+ enum:
28741+ - pending
28742+ - ok
28743+ - warn
28744+ - alert
28745+ - error
28746+ example: pending
28747+ type: string
28748+ x-enum-varnames:
28749+ - PENDING
28750+ - OK
28751+ - WARN
28752+ - ALERT
28753+ - ERROR
28754+ DataObservabilityMonitorRunType:
28755+ default: monitor_run
28756+ description: The JSON:API resource type for a data observability monitor run.
28757+ enum:
28758+ - monitor_run
28759+ example: monitor_run
28760+ type: string
28761+ x-enum-varnames:
28762+ - MONITOR_RUN
2873828763 DataRelationshipsTeams:
2873928764 description: Associates teams with this schedule in a data structure.
2874028765 properties:
@@ -39045,6 +39070,42 @@ components:
3904539070 meta:
3904639071 $ref: "#/components/schemas/DataDeletionResponseMeta"
3904739072 type: object
39073+ GetDataObservabilityMonitorRunStatusResponse:
39074+ description: The response for getting the status of a data observability monitor run.
39075+ properties:
39076+ data:
39077+ $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseData"
39078+ required:
39079+ - data
39080+ type: object
39081+ GetDataObservabilityMonitorRunStatusResponseAttributes:
39082+ description: The attributes of a data observability monitor run status response.
39083+ properties:
39084+ error_message:
39085+ description: Error message describing why the monitor run failed. Only present when status is error.
39086+ example: "run completed but produced no metric data"
39087+ type: string
39088+ status:
39089+ $ref: "#/components/schemas/DataObservabilityMonitorRunStatus"
39090+ required:
39091+ - status
39092+ type: object
39093+ GetDataObservabilityMonitorRunStatusResponseData:
39094+ description: The data object for a data observability monitor run status response.
39095+ properties:
39096+ attributes:
39097+ $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseAttributes"
39098+ id:
39099+ description: The unique identifier of the monitor run.
39100+ example: "abc123def456"
39101+ type: string
39102+ type:
39103+ $ref: "#/components/schemas/DataObservabilityMonitorRunType"
39104+ required:
39105+ - id
39106+ - type
39107+ - attributes
39108+ type: object
3904839109 GetDeviceAttributes:
3904939110 description: The device attributes
3905039111 properties:
@@ -77898,6 +77959,27 @@ components:
7789877959 $ref: "#/components/schemas/RumRetentionFilterData"
7789977960 type: array
7790077961 type: object
77962+ RunDataObservabilityMonitorResponse:
77963+ description: The response returned when a data observability monitor run is triggered.
77964+ properties:
77965+ data:
77966+ $ref: "#/components/schemas/RunDataObservabilityMonitorResponseData"
77967+ required:
77968+ - data
77969+ type: object
77970+ RunDataObservabilityMonitorResponseData:
77971+ description: The data object returned when a data observability monitor run is triggered.
77972+ properties:
77973+ id:
77974+ description: The unique identifier of the monitor run.
77975+ example: "abc123def456"
77976+ type: string
77977+ type:
77978+ $ref: "#/components/schemas/DataObservabilityMonitorRunType"
77979+ required:
77980+ - id
77981+ - type
77982+ type: object
7790177983 RunHistoricalJobRequest:
7790277984 description: Run a historical job request.
7790377985 properties:
@@ -124777,6 +124859,105 @@ paths:
124777124859 x-unstable: |-
124778124860 **Note**: This endpoint is in preview and is subject to change.
124779124861 If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
124862+ /api/v2/data-observability/monitors/runs/{run_id}/status:
124863+ get:
124864+ description: Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.
124865+ operationId: GetDataObservabilityMonitorRunStatus
124866+ parameters:
124867+ - description: The ID of the monitor run to retrieve status for.
124868+ example: "abc123def456"
124869+ in: path
124870+ name: run_id
124871+ required: true
124872+ schema:
124873+ type: string
124874+ responses:
124875+ "200":
124876+ content:
124877+ application/json:
124878+ examples:
124879+ default:
124880+ value:
124881+ data:
124882+ attributes:
124883+ status: ok
124884+ id: "abc123def456"
124885+ type: monitor_run
124886+ schema:
124887+ $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponse"
124888+ description: OK
124889+ "404":
124890+ content:
124891+ application/json:
124892+ schema:
124893+ $ref: "#/components/schemas/JSONAPIErrorResponse"
124894+ description: Not Found
124895+ "429":
124896+ $ref: "#/components/responses/TooManyRequestsResponse"
124897+ security:
124898+ - apiKeyAuth: []
124899+ appKeyAuth: []
124900+ - AuthZ:
124901+ - data_observability_monitors_write
124902+ - monitors_write
124903+ summary: Get data observability monitor run status
124904+ tags:
124905+ - Data Observability
124906+ x-unstable: |-
124907+ **Note**: This endpoint is in preview and is subject to change.
124908+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
124909+ /api/v2/data-observability/monitors/{monitor_id}/run:
124910+ post:
124911+ description: Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.
124912+ operationId: RunDataObservabilityMonitor
124913+ parameters:
124914+ - description: The ID of the data observability monitor to run.
124915+ example: 12345
124916+ in: path
124917+ name: monitor_id
124918+ required: true
124919+ schema:
124920+ format: int64
124921+ type: integer
124922+ responses:
124923+ "200":
124924+ content:
124925+ application/json:
124926+ examples:
124927+ default:
124928+ value:
124929+ data:
124930+ id: "abc123def456"
124931+ type: monitor_run
124932+ schema:
124933+ $ref: "#/components/schemas/RunDataObservabilityMonitorResponse"
124934+ description: OK
124935+ "400":
124936+ content:
124937+ application/json:
124938+ schema:
124939+ $ref: "#/components/schemas/JSONAPIErrorResponse"
124940+ description: Bad Request
124941+ "404":
124942+ content:
124943+ application/json:
124944+ schema:
124945+ $ref: "#/components/schemas/JSONAPIErrorResponse"
124946+ description: Not Found
124947+ "429":
124948+ $ref: "#/components/responses/TooManyRequestsResponse"
124949+ security:
124950+ - apiKeyAuth: []
124951+ appKeyAuth: []
124952+ - AuthZ:
124953+ - data_observability_monitors_write
124954+ - monitors_write
124955+ summary: Run a data observability monitor
124956+ tags:
124957+ - Data Observability
124958+ x-unstable: |-
124959+ **Note**: This endpoint is in preview and is subject to change.
124960+ If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
124780124961 /api/v2/datasets:
124781124962 get:
124782124963 description: Get all datasets that have been configured for an organization.
@@ -186518,6 +186699,8 @@ tags:
186518186699 - description: |-
186519186700 The Data Deletion API allows the user to target and delete data from the allowed products. It's currently enabled for Logs and RUM and depends on `logs_delete_data` and `rum_delete_data` permissions respectively.
186520186701 name: Data Deletion
186702+ - description: Manage and run data observability monitors.
186703+ name: Data Observability
186521186704 - description: |-
186522186705 Data Access Controls in Datadog is a feature that allows administrators and access managers to regulate
186523186706 access to sensitive data. By defining Restricted Datasets, you can ensure that only specific teams or roles can
0 commit comments