Set x-keep-typed-in-additional-properties on UsageSummary schemas

config/_default/menus/api.en.yaml

@@ -10931,6 +10931,36 @@ menu:
         unstable:
           - v2
         order: 5
+    - name: Data Observability
+      url: /api/latest/data-observability/
+      identifier: data-observability
+      generated: true
+    - name: Run a data observability monitor
+      url: /api/latest/data-observability/run-a-data-observability-monitor/
+      identifier: data-observability-run-a-data-observability-monitor
+      parent: data-observability
+      generated: true
+      params:
+        versions:
+          - v2
+        operationids:
+          - RunDataObservabilityMonitor
+        unstable:
+          - v2
+        order: 1
+    - name: Get data observability monitor run status
+      url: /api/latest/data-observability/get-data-observability-monitor-run-status/
+      identifier: data-observability-get-data-observability-monitor-run-status
+      parent: data-observability
+      generated: true
+      params:
+        versions:
+          - v2
+        operationids:
+          - GetDataObservabilityMonitorRunStatus
+        unstable:
+          - v2
+        order: 2
     - name: Datasets
       url: /api/latest/datasets/
       identifier: datasets

content/en/api/latest/data-observability/_index.md

@@ -0,0 +1,3 @@
+---
+title: Data Observability
+---

content/en/api/latest/data-observability/get-data-observability-monitor-run-status/index.md

@@ -0,0 +1,3 @@
+---
+title: Get data observability monitor run status
+---

content/en/api/latest/data-observability/run-a-data-observability-monitor/index.md

@@ -0,0 +1,3 @@
+---
+title: Run a data observability monitor
+---

content/en/api/v2/data-observability/_index.md

@@ -0,0 +1,4 @@
+---
+title: Data Observability
+headless: true
+---

data/api/v2/full_spec.yaml

@@ -28523,6 +28523,31 @@ components:
         - bucket_name
         - bucket_region
       type: object
+    DataObservabilityMonitorRunStatus:
+      description: The status of a data observability monitor run.
+      enum:
+        - pending
+        - ok
+        - warn
+        - alert
+        - error
+      example: pending
+      type: string
+      x-enum-varnames:
+        - PENDING
+        - OK
+        - WARN
+        - ALERT
+        - ERROR
+    DataObservabilityMonitorRunType:
+      default: monitor_run
+      description: The JSON:API resource type for a data observability monitor run.
+      enum:
+        - monitor_run
+      example: monitor_run
+      type: string
+      x-enum-varnames:
+        - MONITOR_RUN
     DataRelationshipsTeams:
       description: Associates teams with this schedule in a data structure.
       properties:
@@ -39197,6 +39222,42 @@ components:
       required:
         - data
       type: object
+    GetDataObservabilityMonitorRunStatusResponse:
+      description: The response for getting the status of a data observability monitor run.
+      properties:
+        data:
+          $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseData"
+      required:
+        - data
+      type: object
+    GetDataObservabilityMonitorRunStatusResponseAttributes:
+      description: The attributes of a data observability monitor run status response.
+      properties:
+        error_message:
+          description: Error message describing why the monitor run failed. Only present when status is error.
+          example: "run completed but produced no metric data"
+          type: string
+        status:
+          $ref: "#/components/schemas/DataObservabilityMonitorRunStatus"
+      required:
+        - status
+      type: object
+    GetDataObservabilityMonitorRunStatusResponseData:
+      description: The data object for a data observability monitor run status response.
+      properties:
+        attributes:
+          $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseAttributes"
+        id:
+          description: The unique identifier of the monitor run.
+          example: "abc123def456"
+          type: string
+        type:
+          $ref: "#/components/schemas/DataObservabilityMonitorRunType"
+      required:
+        - id
+        - type
+        - attributes
+      type: object
     GetDeviceAttributes:
       description: The device attributes
       properties:
@@ -78882,6 +78943,27 @@ components:
             $ref: "#/components/schemas/RumRetentionFilterData"
           type: array
       type: object
+    RunDataObservabilityMonitorResponse:
+      description: The response returned when a data observability monitor run is triggered.
+      properties:
+        data:
+          $ref: "#/components/schemas/RunDataObservabilityMonitorResponseData"
+      required:
+        - data
+      type: object
+    RunDataObservabilityMonitorResponseData:
+      description: The data object returned when a data observability monitor run is triggered.
+      properties:
+        id:
+          description: The unique identifier of the monitor run.
+          example: "abc123def456"
+          type: string
+        type:
+          $ref: "#/components/schemas/DataObservabilityMonitorRunType"
+      required:
+        - id
+        - type
+      type: object
     RunHistoricalJobRequest:
       description: Run a historical job request.
       properties:
@@ -126182,6 +126264,107 @@ paths:
       x-unstable: |-
         **Note**: This endpoint is in preview and is subject to change.
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
+  /api/v2/data-observability/monitors/runs/{run_id}/status:
+    get:
+      description: Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.
+      operationId: GetDataObservabilityMonitorRunStatus
+      parameters:
+        - description: The ID of the monitor run to retrieve status for.
+          example: "abc123def456"
+          in: path
+          name: run_id
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          content:
+            application/json:
+              examples:
+                default:
+                  value:
+                    data:
+                      attributes:
+                        status: ok
+                      id: "abc123def456"
+                      type: monitor_run
+              schema:
+                $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponse"
+          description: OK
+        "404":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/JSONAPIErrorResponse"
+          description: Not Found
+        "429":
+          $ref: "#/components/responses/TooManyRequestsResponse"
+      security:
+        - apiKeyAuth: []
+          appKeyAuth: []
+        - AuthZ:
+            - data_observability_monitors_write
+            - monitors_write
+      summary: Get data observability monitor run status
+      tags:
+        - Data Observability
+      x-menu-order: 2
+      x-unstable: |-
+        **Note**: This endpoint is in preview and is subject to change.
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
+  /api/v2/data-observability/monitors/{monitor_id}/run:
+    post:
+      description: Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.
+      operationId: RunDataObservabilityMonitor
+      parameters:
+        - description: The ID of the data observability monitor to run.
+          example: 12345
+          in: path
+          name: monitor_id
+          required: true
+          schema:
+            format: int64
+            type: integer
+      responses:
+        "200":
+          content:
+            application/json:
+              examples:
+                default:
+                  value:
+                    data:
+                      id: "abc123def456"
+                      type: monitor_run
+              schema:
+                $ref: "#/components/schemas/RunDataObservabilityMonitorResponse"
+          description: OK
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/JSONAPIErrorResponse"
+          description: Bad Request
+        "404":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/JSONAPIErrorResponse"
+          description: Not Found
+        "429":
+          $ref: "#/components/responses/TooManyRequestsResponse"
+      security:
+        - apiKeyAuth: []
+          appKeyAuth: []
+        - AuthZ:
+            - data_observability_monitors_write
+            - monitors_write
+      summary: Run a data observability monitor
+      tags:
+        - Data Observability
+      x-menu-order: 1
+      x-unstable: |-
+        **Note**: This endpoint is in preview and is subject to change.
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
   /api/v2/datasets:
     get:
       description: Get all datasets that have been configured for an organization.
@@ -189668,6 +189851,8 @@ tags:
       [Dashboards documentation](https://docs.datadoghq.com/dashboards/) for more
       information.
     name: Dashboards
+  - description: Manage and run data observability monitors.
+    name: Data Observability
   - description: |-
       Data Access Controls in Datadog is a feature that allows administrators and access managers to regulate
       access to sensitive data. By defining Restricted Datasets, you can ensure that only specific teams or roles can

data/api/v2/translate_actions.json

@@ -1564,6 +1564,14 @@
     "description": "Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM.",
     "summary": "Get usage stats for a dashboard"
   },
+  "GetDataObservabilityMonitorRunStatus": {
+    "description": "Retrieves the current status of a data observability monitor run. Poll this endpoint after triggering a run to determine when evaluation is complete.",
+    "summary": "Get data observability monitor run status"
+  },
+  "RunDataObservabilityMonitor": {
+    "description": "Manually triggers a run for a data observability monitor. Only monitors that are not scheduled (manually-runnable) can be triggered this way.",
+    "summary": "Run a data observability monitor"
+  },
   "GetAllDatasets": {
     "description": "Get all datasets that have been configured for an organization.",
     "summary": "Get all datasets"

data/api/v2/translate_tags.json

@@ -163,6 +163,10 @@
     "name": "Dashboards",
     "description": "Get usage statistics for the dashboards in your organization, including view\ncounts, last-edit times, widget counts, and quality scores. See the\n[Dashboards documentation](https://docs.datadoghq.com/dashboards/) for more\ninformation."
   },
+  "data-observability": {
+    "name": "Data Observability",
+    "description": "Manage and run data observability monitors."
+  },
   "datasets": {
     "name": "Datasets",
     "description": "Data Access Controls in Datadog is a feature that allows administrators and access managers to regulate\naccess to sensitive data. By defining Restricted Datasets, you can ensure that only specific teams or roles can\nview certain types of telemetry (for example, logs, traces, metrics, and RUM data)."