{ "swagger": "2.0", "info": { "title": "Data review service", "version": "0.1507.0", "description": "Send your API key as a bearer token: `Authorization: Bearer `." }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "ApiKey": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Your API key as a bearer token: `Authorization: Bearer `." } }, "security": [ { "ApiKey": [] } ], "paths": { "/scout/v2/data-review/batch-initiate": { "post": { "operationId": "DataReviewService_batchInitiate", "summary": "Batch initiate", "tags": [ "Data Review Service" ], "description": "For each request, initiates data review for the requested run and checklist and executes the automatic checks against the run.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchInitiateDataReviewRequest" }, "required": true, "x-example": { "requests": [ { "runRid": "", "checklistRid": "" } ], "notificationConfigurations": [ { "integrationRid": "" } ] } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchInitiateDataReviewResponse" }, "x-example": { "rids": [ "" ] } } } } }, "/scout/v2/data-review/rerun-failed-automatic-checks": { "post": { "operationId": "DataReviewService_rerunFailedAutomaticChecks", "summary": "Rerun failed automatic checks", "tags": [ "Data Review Service" ], "description": "Re-executes the most recent failed automatic checks for the data review.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/RerunFailedAutomaticChecksRequest" }, "required": true, "x-example": { "dataReviewRid": "" } } ], "responses": { "204": { "description": "No content." } } } }, "/scout/v2/data-review/search": { "post": { "operationId": "DataReviewService_findDataReviews", "summary": "Find data reviews", "tags": [ "Data Review Service" ], "description": "Returns the data reviews under the provided search parameters.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/FindDataReviewsRequest" }, "required": true, "x-example": { "runRids": [ "" ], "assetRids": [ "" ], "filterByBothRunsAndAssets": true, "checklistRefs": [ { "rid": "" } ], "nextPageToken": "", "pageSize": 1, "showArchived": true, "archivedStatuses": [ "NOT_ARCHIVED" ] } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/DataReviewPage" }, "x-example": { "dataReviews": [ { "rid": "", "runRid": "", "assetRid": "", "createdAt": "2026-01-01T00:00:00Z", "createdBy": "", "checklist": { "checklist": { "rid": "", "commit": "" }, "dataReviewRid": "", "checks": [ { "type": "automaticCheck", "automaticCheck": { "rid": "", "checkRid": "", "checkImplementationIndex": 1, "dataReviewRid": "", "state": { "type": "pendingExecution", "pendingExecution": { "jobRid": "" } } } } ] }, "checklistRef": { "rid": "", "commit": "" }, "checkEvaluations": [ { "rid": "", "checkRid": "", "checkImplementationIndex": 1, "dataReviewRid": "", "state": { "type": "pendingExecution", "pendingExecution": { "jobRid": "" } } } ], "archived": true } ], "nextPageToken": "" } } } } }, "/scout/v2/data-review/{dataReviewRid}": { "get": { "operationId": "DataReviewService_get", "summary": "Get", "tags": [ "Data Review Service" ], "description": "Throws if not found.", "parameters": [ { "name": "dataReviewRid", "in": "path", "type": "string", "format": "rid", "x-alias": "DataReviewRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/DataReview" }, "x-example": { "rid": "", "runRid": "", "assetRid": "", "createdAt": "2026-01-01T00:00:00Z", "createdBy": "", "checklist": { "checklist": { "rid": "", "commit": "" }, "dataReviewRid": "", "checks": [ { "type": "automaticCheck", "automaticCheck": { "rid": "", "checkRid": "", "checkImplementationIndex": 1, "dataReviewRid": "", "state": { "type": "pendingExecution", "pendingExecution": { "jobRid": "" } } } } ] }, "checklistRef": { "rid": "", "commit": "" }, "checkEvaluations": [ { "rid": "", "checkRid": "", "checkImplementationIndex": 1, "dataReviewRid": "", "state": { "type": "pendingExecution", "pendingExecution": { "jobRid": "" } } } ], "archived": true } } } } }, "/scout/v2/data-review/check-alerts/{checkAlertRid}": { "get": { "operationId": "DataReviewService_getCheckAlert", "summary": "Get check alert", "tags": [ "Data Review Service" ], "description": "Throws if not found.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "checkAlertRid", "in": "path", "type": "string", "format": "rid", "x-alias": "CheckAlertRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CheckAlert" }, "x-example": { "rid": "", "checkRid": "", "implementationIndex": 1, "dataReviewRid": "", "checkEvaluationRid": "", "name": "", "autogeneratedCheckTitle": "", "autogeneratedCheckDescription": "", "assigneeRids": [ "" ], "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "state": { "type": "pendingReview", "pendingReview": {} }, "priority": "P0", "chart": { "rid": "", "version": 1 }, "notes": "", "notebook": "" } } } }, "put": { "operationId": "DataReviewService_performCheckAlertAction", "summary": "Perform check alert action", "tags": [ "Data Review Service" ], "description": "Applies a check alert action to the specified check alert RID.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "checkAlertRid", "in": "path", "type": "string", "format": "rid", "x-alias": "CheckAlertRid", "required": true }, { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/CheckAlertAction" }, "required": true, "x-example": { "type": "closeWithIgnore", "closeWithIgnore": { "comment": "" } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CheckAlert" }, "x-example": { "rid": "", "checkRid": "", "implementationIndex": 1, "dataReviewRid": "", "checkEvaluationRid": "", "name": "", "autogeneratedCheckTitle": "", "autogeneratedCheckDescription": "", "assigneeRids": [ "" ], "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "state": { "type": "pendingReview", "pendingReview": {} }, "priority": "P0", "chart": { "rid": "", "version": 1 }, "notes": "", "notebook": "" } } } } }, "/scout/v2/data-review/{dataReviewRid}/check-alerts": { "get": { "operationId": "DataReviewService_getCheckAlertsForDataReview", "summary": "Get check alerts for data review", "tags": [ "Data Review Service" ], "description": "Gets all check alerts from the provided data review.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "dataReviewRid", "in": "path", "type": "string", "format": "rid", "x-alias": "DataReviewRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "type": "array", "items": { "$ref": "#/definitions/CheckAlert" }, "uniqueItems": true }, "x-example": [ { "rid": "", "checkRid": "", "implementationIndex": 1, "dataReviewRid": "", "checkEvaluationRid": "", "name": "", "autogeneratedCheckTitle": "", "autogeneratedCheckDescription": "", "assigneeRids": [ "" ], "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "state": { "type": "pendingReview", "pendingReview": {} }, "priority": "P0", "chart": { "rid": "", "version": 1 }, "notes": "", "notebook": "" } ] } } } }, "/scout/v2/data-review/check-alerts/histogram": { "post": { "operationId": "DataReviewService_getCheckAlertsHistogram", "summary": "Get check alerts histogram", "tags": [ "Data Review Service" ], "description": "Returns a histogram of alerts that occur across the provided runs or assets. At least one run or asset must be specified.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/CheckAlertsHistogramRequest" }, "required": true, "x-example": { "distributionVariable": { "type": "startTime", "startTime": {} }, "startTimeAfter": { "seconds": 1, "nanos": 1 }, "startTimeBefore": { "seconds": 1, "nanos": 1 } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CheckAlertsHistogramResponse" }, "x-example": { "buckets": { "type": "unstacked", "unstacked": { "buckets": [ { "startInclusive": { "seconds": 1, "nanos": 1 }, "endExclusive": { "seconds": 1, "nanos": 1 }, "count": 1 } ] } } } } } } }, "/scout/v2/data-review/check-alerts": { "post": { "operationId": "DataReviewService_searchCheckAlerts", "summary": "Search check alerts", "tags": [ "Data Review Service" ], "description": "Returns the check alerts under the provided search parameters. At least one run or asset must be specified.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/SearchCheckAlertsRequest" }, "required": true, "x-example": { "nextPageToken": "", "pageSize": 1, "sortBy": { "isDescending": true, "field": "CHECK_NAME" }, "searchText": "", "after": { "seconds": 1, "nanos": 1 }, "before": { "seconds": 1, "nanos": 1 }, "status": [ "PENDING_REVIEW" ], "checkRids": [ "" ], "dataReviewRids": [ "" ], "assigneeRids": [ "" ], "priorities": [ "P0" ], "runRids": [ "" ], "assetRids": [ "" ], "pinnedChecklistRefs": [ { "rid": "", "commit": "" } ], "chartRids": [ { "rid": "", "version": 1 } ], "notebookRids": [ "" ], "showArchived": true, "archivedStatuses": [ "NOT_ARCHIVED" ] } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SearchCheckAlertsResponse" }, "x-example": { "nextPageToken": "", "checkAlerts": [ { "rid": "", "checkRid": "", "implementationIndex": 1, "dataReviewRid": "", "checkEvaluationRid": "", "name": "", "autogeneratedCheckTitle": "", "autogeneratedCheckDescription": "", "assigneeRids": [ "" ], "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "state": { "type": "pendingReview", "pendingReview": {} }, "priority": "P0", "chart": { "rid": "", "version": 1 }, "notes": "", "notebook": "" } ] } } } } }, "/scout/v2/data-review/check-alerts/{checkAlertRid}/action-log": { "get": { "operationId": "DataReviewService_getCheckAlertActionLog", "summary": "Get check alert action log", "tags": [ "Data Review Service" ], "description": "Returns a record of the historical actions taken on the provided check alert.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "checkAlertRid", "in": "path", "type": "string", "format": "rid", "x-alias": "CheckAlertRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CheckAlertActionLog" }, "x-example": { "entries": [ { "performedBy": "", "action": { "type": "closeWithIgnore", "closeWithIgnore": { "comment": "", "strategy": { "type": "closeAllLinkedAlerts", "closeAllLinkedAlerts": {} } } }, "timestamp": "2026-01-01T00:00:00Z" } ] } } } } }, "/scout/v2/data-review/get-check-alert-counts-for-notebooks": { "post": { "operationId": "DataReviewService_getCheckAlertCountsForNotebooks", "summary": "Get check alert counts for notebooks", "tags": [ "Data Review Service" ], "description": "Returns the number of alerts attached to each provided notebook.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "rids", "in": "body", "schema": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "NotebookRid" }, "uniqueItems": true, "example": [ "" ] }, "required": false, "x-example": [ "" ] } ], "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "x-map-key": "NotebookRid" }, "x-example": { "": 1 } } } } }, "/scout/v2/data-review/get-check-alert-status-for-notebooks": { "post": { "operationId": "DataReviewService_getCheckAlertStatusForNotebooks", "summary": "Get check alert status for notebooks", "tags": [ "Data Review Service" ], "description": "Returns the check alert status of any linked violations for the provided notebooks. If none exist, an empty optional is returned.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "rids", "in": "body", "schema": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "NotebookRid" }, "uniqueItems": true, "example": [ "" ] }, "required": false, "x-example": [ "" ] } ], "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "additionalProperties": { "$ref": "#/definitions/CheckAlertStatus" }, "x-map-key": "NotebookRid" }, "x-example": { "": "PENDING_REVIEW" } } } } }, "/scout/v2/data-review/check-alerts/batch-perform-action": { "post": { "operationId": "DataReviewService_batchPerformCheckAlertAction", "summary": "Batch perform check alert action", "tags": [ "Data Review Service" ], "description": "Applies a check alert action to the specified check alert RIDs. If any of the check actions fail, then none of the check actions will be applied.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchCheckAlertActionRequest" }, "required": true, "x-example": { "checkAlertAction": { "type": "closeWithIgnore", "closeWithIgnore": { "comment": "" } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchCheckAlertActionResponse" }, "x-example": { "checkAlerts": [ { "rid": "", "checkRid": "", "implementationIndex": 1, "dataReviewRid": "", "checkEvaluationRid": "", "name": "", "autogeneratedCheckTitle": "", "autogeneratedCheckDescription": "", "assigneeRids": [ "" ], "start": { "seconds": 1, "nanos": 1 }, "end": { "seconds": 1, "nanos": 1 }, "state": { "type": "pendingReview", "pendingReview": {} }, "priority": "P0", "chart": { "rid": "", "version": 1 }, "notes": "", "notebook": "" } ] } } } } }, "/scout/v2/data-review/automatic-check-evaluation/batch-perform-action": { "post": { "operationId": "DataReviewService_batchPerformAutomaticCheckEvaluationReviewAction", "summary": "Batch perform automatic check evaluation review action", "tags": [ "Data Review Service" ], "description": "Applies an action to the specified check evaluation RIDs. If any of the check actions fail, then none of the actions will be applied.", "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchAutomaticCheckEvaluationActionRequest" }, "required": true, "x-example": { "checkEvaluationAction": { "type": "closeWithIgnore", "closeWithIgnore": { "comment": "" } } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/BatchAutomaticCheckEvaluationActionResponse" }, "x-example": { "checkEvaluations": [ { "rid": "", "checkRid": "", "checkImplementationIndex": 1, "dataReviewRid": "", "state": { "type": "pendingExecution", "pendingExecution": { "jobRid": "" } } } ] } } } } }, "/scout/v2/data-review/automatic-check-evaluation/{rid}/action-log": { "get": { "operationId": "DataReviewService_getAutomaticCheckEvaluationActionLog", "summary": "Get automatic check evaluation action log", "tags": [ "Data Review Service" ], "deprecated": true, "x-deprecated": "CheckAlerts have been replaced by Events. Please use the EventService instead.", "parameters": [ { "name": "rid", "in": "path", "type": "string", "format": "rid", "x-alias": "AutomaticCheckEvaluationRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/AutomaticCheckEvaluationActionLog" }, "x-example": { "entries": [ { "action": { "type": "executionFinished", "executionFinished": { "jobRid": "", "status": "PASS" } }, "timestamp": "2026-01-01T00:00:00Z" } ] } } } } }, "/scout/v2/data-review/manual-check-evaluation/batch-perform-action": { "post": { "operationId": "DataReviewService_batchPerformManualCheckAlertAction", "summary": "Batch perform manual check alert action", "tags": [ "Data Review Service" ], "description": "Applies an action to the specified check evaluation RIDs. If any of the check actions fail, then none of the actions will be applied.", "deprecated": true, "x-deprecated": "No longer in use", "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/BatchManualCheckEvaluationActionRequest" }, "required": true, "x-example": { "checkAlertAction": { "type": "pass", "pass": { "comment": "" } } } } ], "responses": { "204": { "description": "No content." } } } }, "/scout/v2/data-review/manual-check-evaluation/{rid}/action-log": { "get": { "operationId": "DataReviewService_getManualCheckEvaluationActionLog", "summary": "Get manual check evaluation action log", "tags": [ "Data Review Service" ], "description": "Returns a record of the historical manual actions taken on the provided check evaluation.", "deprecated": true, "x-deprecated": "No longer in use", "parameters": [ { "name": "rid", "in": "path", "type": "string", "format": "rid", "x-alias": "ManualCheckEvaluationRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ManualCheckEvaluationActionLog" }, "x-example": { "entries": [ { "performedBy": "", "action": { "type": "pass", "pass": { "comment": "" } }, "timestamp": "2026-01-01T00:00:00Z" } ] } } } } }, "/scout/v2/data-review/{dataReviewRid}/archive": { "post": { "operationId": "DataReviewService_archiveDataReview", "summary": "Archive data review", "tags": [ "Data Review Service" ], "description": "Archives the data review with the given rid.", "parameters": [ { "name": "dataReviewRid", "in": "path", "type": "string", "format": "rid", "x-alias": "DataReviewRid", "required": true } ], "responses": { "200": { "description": "A successful response.", "schema": { "type": "boolean" }, "x-example": true } } } }, "/scout/v2/data-review/batch-archive": { "post": { "operationId": "DataReviewService_batchArchiveDataReview", "summary": "Batch archive data review", "tags": [ "Data Review Service" ], "description": "Batch archives the data reviews with the given rids.", "parameters": [ { "name": "rids", "in": "body", "schema": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" }, "uniqueItems": true, "example": [ "" ] }, "required": false, "x-example": [ "" ] } ], "responses": { "204": { "description": "No content." } } } }, "/scout/v2/data-review/unarchive/{dataReviewRid}": { "post": { "operationId": "DataReviewService_unarchiveDataReview", "summary": "Unarchive data review", "tags": [ "Data Review Service" ], "description": "Unarchives the data review with the given rid.", "parameters": [ { "name": "dataReviewRid", "in": "path", "type": "string", "format": "rid", "x-alias": "DataReviewRid", "required": true } ], "responses": { "204": { "description": "No content." } } } }, "/scout/v2/data-review/data-review-check-metrics": { "post": { "operationId": "DataReviewService_getDataReviewCheckMetrics", "summary": "Get data review check metrics", "tags": [ "Data Review Service" ], "parameters": [ { "name": "request", "in": "body", "schema": { "$ref": "#/definitions/GetDataReviewCheckMetricsRequest" }, "required": true, "x-example": { "scope": { "type": "runRid", "runRid": "" } } } ], "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetDataReviewCheckMetricsResponse" }, "x-example": { "checksPendingExecution": 1, "checksExecuting": 1, "checksPassed": 1, "checksWithEventsPendingReview": 1, "checksWithEventsClosedWithIgnore": 1, "checksWithEventsClosedWithFurtherAction": 1, "checksWithEvents": 1, "checksWithTooManyEvents": 1, "checksFailedToExecutePendingReview": 1, "checksFailedToExecuteClosedWithIgnore": 1, "checksFailedToExecuteClosedWithFurtherAction": 1, "checksFailedToExecute": 1, "checksExecuted": 1, "checksTotal": 1, "eventsPendingReview": 1, "eventsClosedWithIgnore": 1, "eventsClosedWithFurtherAction": 1, "eventsTotal": 1 } } } } } }, "definitions": { "ArchivedStatus": { "type": "string", "enum": [ "NOT_ARCHIVED", "ARCHIVED" ] }, "Timestamp": { "description": "Deprecated for new APIs. Use google.protobuf.Timestamp for absolute instants in proto APIs.\n\nThis legacy nanosecond precision timestamp type is represented by an epoch time in seconds and a nanosecond offset. The nanosecond offset is from the start of the epoch second, so must be less than 1 billion.", "type": "object", "properties": { "seconds": { "type": "integer", "format": "int64" }, "nanos": { "type": "integer", "format": "int64" } }, "required": [ "seconds", "nanos" ] }, "Priority": { "type": "string", "enum": [ "P0", "P1", "P2", "P3", "P4" ] }, "ChecklistRef": { "description": "A reference to a checklist that may be pinned to a specific commit. If commit is empty, this refers to \"the latest commit on main\".", "type": "object", "properties": { "rid": { "type": "string", "format": "rid", "x-alias": "ChecklistRid" }, "commit": { "type": "string", "x-alias": "CommitId" } }, "required": [ "rid" ] }, "PinnedChecklistRef": { "description": "A reference to a checklist that is pinned to a specific commit.", "type": "object", "properties": { "rid": { "type": "string", "format": "rid", "x-alias": "ChecklistRid" }, "commit": { "type": "string", "x-alias": "CommitId" } }, "required": [ "rid", "commit" ] }, "ArchiveDataReview": { "description": "Archive the data review which created this check alert. Only performable via the archive data review endpoint; not supported by Perform Check Alert Action.", "type": "object", "properties": {} }, "AutomaticCheckEvaluation": { "type": "object", "properties": { "rid": { "type": "string", "format": "rid", "x-alias": "AutomaticCheckEvaluationRid" }, "checkRid": { "type": "string", "format": "rid", "x-alias": "CheckRid" }, "checkImplementationIndex": { "type": "integer", "format": "int32", "description": "Checks can define a single range computation which can evaluate over multiple implementations of a context. The check implementation index will correspond to the implementation index of the check condition." }, "dataReviewRid": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" }, "state": { "$ref": "#/definitions/AutomaticCheckEvaluationState" } }, "required": [ "rid", "checkRid", "dataReviewRid", "state" ] }, "AutomaticCheckEvaluationAction": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "executionFinished", "executionFailedToRun", "executionRetriggered", "executionStarted" ] }, "executionFinished": { "$ref": "#/definitions/AutomaticCheckExecutionFinished" }, "executionFailedToRun": { "$ref": "#/definitions/AutomaticCheckExecutionFailedToRun" }, "executionRetriggered": { "$ref": "#/definitions/ExecutionRetriggered" }, "executionStarted": { "$ref": "#/definitions/AutomaticCheckExecutionStarted" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "executionFinished", "executionFinished": { "jobRid": "string", "status": "PASS" } } }, "AutomaticCheckEvaluationActionLog": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/definitions/AutomaticCheckEvaluationActionLogEntry" } } } }, "AutomaticCheckEvaluationActionLogEntry": { "type": "object", "properties": { "action": { "$ref": "#/definitions/AutomaticCheckEvaluationAction" }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "action", "timestamp" ] }, "AutomaticCheckEvaluationReviewAction": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "closeWithIgnore", "closeWithFurtherAction", "reopen", "reassign", "updateNotes" ] }, "closeWithIgnore": { "$ref": "#/definitions/CloseWithIgnoreAlert" }, "closeWithFurtherAction": { "$ref": "#/definitions/CloseWithFurtherAction" }, "reopen": { "$ref": "#/definitions/Reopen" }, "reassign": { "$ref": "#/definitions/Reassign" }, "updateNotes": { "$ref": "#/definitions/UpdateNotes" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "closeWithIgnore", "closeWithIgnore": { "comment": "string", "strategy": { "type": "closeAllLinkedAlerts", "closeAllLinkedAlerts": {} } } } }, "AutomaticCheckEvaluationState": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "pendingExecution", "failedToExecute", "passing", "generatedAlerts", "tooManyAlerts", "executing" ] }, "pendingExecution": { "$ref": "#/definitions/PendingExecutionState" }, "failedToExecute": { "$ref": "#/definitions/FailedToExecuteState" }, "passing": { "$ref": "#/definitions/PassingExecutionState" }, "generatedAlerts": { "$ref": "#/definitions/GeneratedAlertsState" }, "tooManyAlerts": { "$ref": "#/definitions/TooManyAlertsState" }, "executing": { "$ref": "#/definitions/ExecutingState" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "pendingExecution", "pendingExecution": { "jobRid": "string" } } }, "AutomaticCheckExecutionFailedToRun": { "type": "object", "properties": { "jobRid": { "type": "string", "format": "rid", "x-alias": "JobRid" } }, "required": [ "jobRid" ] }, "AutomaticCheckExecutionFinished": { "type": "object", "properties": { "jobRid": { "type": "string", "format": "rid", "x-alias": "JobRid" }, "status": { "$ref": "#/definitions/Status" } }, "required": [ "jobRid", "status" ] }, "AutomaticCheckExecutionStarted": { "type": "object", "properties": { "jobRid": { "type": "string", "format": "rid", "x-alias": "JobRid" } }, "required": [ "jobRid" ] }, "BatchAutomaticCheckEvaluationActionRequest": { "type": "object", "properties": { "checkEvaluationAction": { "$ref": "#/definitions/AutomaticCheckEvaluationReviewAction" }, "checkEvaluationRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AutomaticCheckEvaluationRid" }, "uniqueItems": true } }, "required": [ "checkEvaluationAction" ], "example": { "checkEvaluationAction": { "type": "closeWithIgnore", "closeWithIgnore": { "comment": "" } } } }, "BatchAutomaticCheckEvaluationActionResponse": { "type": "object", "properties": { "checkEvaluations": { "type": "array", "items": { "$ref": "#/definitions/AutomaticCheckEvaluation" }, "uniqueItems": true } } }, "BatchCheckAlertActionRequest": { "type": "object", "properties": { "checkAlertAction": { "$ref": "#/definitions/CheckAlertAction" }, "checkAlertRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "CheckAlertRid" }, "uniqueItems": true } }, "required": [ "checkAlertAction" ], "example": { "checkAlertAction": { "type": "closeWithIgnore", "closeWithIgnore": { "comment": "" } } } }, "BatchCheckAlertActionResponse": { "type": "object", "properties": { "checkAlerts": { "type": "array", "items": { "$ref": "#/definitions/CheckAlert" }, "uniqueItems": true } } }, "BatchInitiateDataReviewRequest": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/definitions/CreateDataReviewRequest" } }, "notificationConfigurations": { "type": "array", "items": { "$ref": "#/definitions/NotificationConfiguration" }, "description": "If provided, checklist violations will be sent to the specified integrations." } }, "example": { "requests": [ { "runRid": "", "checklistRid": "" } ], "notificationConfigurations": [ { "integrationRid": "" } ] } }, "BatchInitiateDataReviewResponse": { "description": "Responses are returned in the same order as the requests.", "type": "object", "properties": { "rids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" } } } }, "BatchManualCheckEvaluationActionRequest": { "type": "object", "properties": { "checkAlertAction": { "$ref": "#/definitions/ManualCheckAlertAction" }, "checkEvaluationRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "ManualCheckEvaluationRid" }, "uniqueItems": true } }, "required": [ "checkAlertAction" ], "example": { "checkAlertAction": { "type": "pass", "pass": { "comment": "" } } } }, "CheckAlert": { "type": "object", "properties": { "rid": { "type": "string", "format": "rid", "x-alias": "CheckAlertRid" }, "checkRid": { "type": "string", "format": "rid", "x-alias": "CheckRid" }, "implementationIndex": { "type": "integer", "format": "int32" }, "dataReviewRid": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" }, "checkEvaluationRid": { "type": "string", "format": "rid", "x-alias": "AutomaticCheckEvaluationRid" }, "name": { "type": "string" }, "autogeneratedCheckTitle": { "type": "string" }, "autogeneratedCheckDescription": { "type": "string" }, "assigneeRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "uniqueItems": true }, "start": { "$ref": "#/definitions/Timestamp" }, "end": { "$ref": "#/definitions/Timestamp" }, "state": { "$ref": "#/definitions/CheckAlertState" }, "priority": { "$ref": "#/definitions/Priority" }, "chart": { "allOf": [ { "$ref": "#/definitions/VersionedVizId" } ], "x-deprecated": "charts are no longer versioned resources." }, "notes": { "type": "string" }, "notebook": { "type": "string", "format": "rid", "x-alias": "NotebookRid" } }, "required": [ "rid", "checkRid", "dataReviewRid", "checkEvaluationRid", "name", "start", "state", "priority" ] }, "CheckAlertAction": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "closeWithIgnore", "closeWithFurtherAction", "reopen", "reassign", "updateNotes", "linkNotebook", "unlinkNotebook", "archiveDataReview", "unarchiveDataReview" ] }, "closeWithIgnore": { "$ref": "#/definitions/CloseWithIgnoreAlert" }, "closeWithFurtherAction": { "$ref": "#/definitions/CloseWithFurtherAction" }, "reopen": { "$ref": "#/definitions/Reopen" }, "reassign": { "$ref": "#/definitions/Reassign" }, "updateNotes": { "$ref": "#/definitions/UpdateNotes" }, "linkNotebook": { "$ref": "#/definitions/LinkNotebook" }, "unlinkNotebook": { "$ref": "#/definitions/UnlinkNotebook" }, "archiveDataReview": { "$ref": "#/definitions/ArchiveDataReview" }, "unarchiveDataReview": { "$ref": "#/definitions/UnarchiveDataReview" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "closeWithIgnore", "closeWithIgnore": { "comment": "string", "strategy": { "type": "closeAllLinkedAlerts", "closeAllLinkedAlerts": {} } } } }, "CheckAlertActionLog": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/definitions/CheckAlertActionLogEntry" } } } }, "CheckAlertActionLogEntry": { "type": "object", "properties": { "performedBy": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "action": { "$ref": "#/definitions/CheckAlertAction" }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "performedBy", "action", "timestamp" ] }, "CheckAlertStatus": { "type": "string", "enum": [ "PENDING_REVIEW", "CLOSED_IGNORED", "CLOSED_REQUIRES_FURTHER_ACTION" ] }, "CheckAlertsHistogramBuckets": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "unstacked", "priority", "status" ] }, "unstacked": { "$ref": "#/definitions/CheckAlertsUnstackedHistogram" }, "priority": { "$ref": "#/definitions/CheckAlertsPriorityHistogram" }, "status": { "$ref": "#/definitions/CheckAlertsStatusHistogram" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "unstacked", "unstacked": { "buckets": [ { "startInclusive": { "seconds": 1, "nanos": 1 }, "endExclusive": { "seconds": 1, "nanos": 1 }, "count": 1 } ] } } }, "CheckAlertsHistogramRequest": { "type": "object", "properties": { "numBins": { "type": "integer", "format": "int32", "description": "Defaults to 100. Throws if larger than 1_000." }, "searchText": { "type": "string", "description": "Matches on check name" }, "distributionVariable": { "allOf": [ { "$ref": "#/definitions/HistogramDistributionVariable" } ], "description": "Represents the data points on the x-axis of a histogram." }, "subGroupVariable": { "allOf": [ { "$ref": "#/definitions/HistogramSubGroupVariable" } ], "description": "The variable that divides the data into distinct groups for comparison within the histogram." }, "startTimeAfter": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "Filters to start times after this time, inclusive." }, "startTimeBefore": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "Filters to start times before this time, exclusive." }, "status": { "type": "array", "items": { "$ref": "#/definitions/CheckAlertStatus" }, "uniqueItems": true }, "checkRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "CheckRid" }, "uniqueItems": true }, "dataReviewRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" }, "uniqueItems": true }, "assigneeRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "uniqueItems": true }, "priorities": { "type": "array", "items": { "$ref": "#/definitions/Priority" }, "uniqueItems": true }, "runRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "uniqueItems": true }, "assetRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" }, "uniqueItems": true }, "pinnedChecklistRefs": { "type": "array", "items": { "$ref": "#/definitions/PinnedChecklistRef" }, "uniqueItems": true }, "chartRids": { "type": "array", "items": { "$ref": "#/definitions/VersionedVizId" }, "uniqueItems": true, "x-deprecated": "charts are no longer versioned resources." }, "notebookRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "NotebookRid" }, "uniqueItems": true }, "showArchived": { "type": "boolean", "description": "To be deprecated. Use archivedStatuses instead. If not present, will not show archived data reviews in search results." }, "archivedStatuses": { "type": "array", "items": { "$ref": "#/definitions/ArchivedStatus" }, "uniqueItems": true, "description": "Filters search on check alerts based on the archived statuses provided. Default is NOT_ARCHIVED only if none are provided." } }, "required": [ "distributionVariable", "startTimeAfter", "startTimeBefore" ], "example": { "distributionVariable": { "type": "startTime", "startTime": {} }, "startTimeAfter": { "seconds": 1, "nanos": 1 }, "startTimeBefore": { "seconds": 1, "nanos": 1 } } }, "CheckAlertsHistogramResponse": { "type": "object", "properties": { "buckets": { "$ref": "#/definitions/CheckAlertsHistogramBuckets" } }, "required": [ "buckets" ] }, "CheckAlertsPriorityHistogram": { "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/HistogramPriorityBucket" } } } }, "CheckAlertsStatusHistogram": { "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/HistogramStatusBucket" } } } }, "CheckAlertsUnstackedHistogram": { "type": "object", "properties": { "buckets": { "type": "array", "items": { "$ref": "#/definitions/HistogramBucket" } } } }, "CheckEvaluation": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "automaticCheck", "manualCheck" ] }, "automaticCheck": { "$ref": "#/definitions/AutomaticCheckEvaluation" }, "manualCheck": { "$ref": "#/definitions/ManualCheckEvaluation" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "automaticCheck", "automaticCheck": { "rid": "string", "checkRid": "string", "checkImplementationIndex": 1, "dataReviewRid": "string", "state": { "type": "pendingExecution", "pendingExecution": { "jobRid": "string" } } } } }, "ChecklistEvaluation": { "type": "object", "properties": { "checklist": { "$ref": "#/definitions/PinnedChecklistRef" }, "dataReviewRid": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" }, "checks": { "type": "array", "items": { "$ref": "#/definitions/CheckEvaluation" }, "uniqueItems": true } }, "required": [ "checklist", "dataReviewRid" ] }, "CloseAction": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "closeWithIgnore", "closeWithFurtherAction" ] }, "closeWithIgnore": { "$ref": "#/definitions/CloseWithIgnoreAlert" }, "closeWithFurtherAction": { "$ref": "#/definitions/CloseWithFurtherAction" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "closeWithIgnore", "closeWithIgnore": { "comment": "string", "strategy": { "type": "closeAllLinkedAlerts", "closeAllLinkedAlerts": {} } } } }, "CloseAllLinkedAlerts": { "description": "Close all alerts associated with the same notebook with the same comment.", "type": "object", "properties": {} }, "CloseAndDetachFromNotebook": { "description": "Close the alert and detach it from the notebook. If the alert is linked to the same notebook as other alerts, those alerts will maintain the reference to the notebook and the notebook will remain unlocked.", "type": "object", "properties": {} }, "CloseAndDuplicatePreviouslyLinkedNotebook": { "description": "Close the alert and detach it from the notebook. If the alert is linked to the same notebook as other alerts, the notebook will be duplicated and the alert will be linked to the new notebook. The new notebook will be locked.", "type": "object", "properties": {} }, "CloseAndLinkToNotebook": { "description": "Close the alert and link to notebook. Throws if the associated notebook has open alerts.", "type": "object", "properties": { "closeAction": { "$ref": "#/definitions/CloseAction" } }, "required": [ "closeAction" ] }, "CloseStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "closeAllLinkedAlerts", "closeAndDetachFromNotebook", "closeAndDuplicatePreviouslyLinkedNotebook" ] }, "closeAllLinkedAlerts": { "$ref": "#/definitions/CloseAllLinkedAlerts" }, "closeAndDetachFromNotebook": { "$ref": "#/definitions/CloseAndDetachFromNotebook" }, "closeAndDuplicatePreviouslyLinkedNotebook": { "$ref": "#/definitions/CloseAndDuplicatePreviouslyLinkedNotebook" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "closeAllLinkedAlerts", "closeAllLinkedAlerts": {} } }, "CloseWithFurtherAction": { "description": "Close the alert with further action. If the alert is linked to the same notebook as other alerts, the other alerts will also be closed with further action. This will also lock the associated notebook.", "type": "object", "properties": { "comment": { "type": "string" }, "strategy": { "allOf": [ { "$ref": "#/definitions/CloseStrategy" } ], "description": "Defines the strategy for reopening the alert and any alerts linked via an associated notebook. If not provided, the alert will be closed naively and throw if it leaves a linked notebook in an invalid state." } }, "required": [ "comment" ] }, "CloseWithIgnoreAlert": { "description": "Close the alert with ignore. If the alert is linked to the same notebook as other alerts, the other alerts will also be closed with ignore. This will also lock the associated notebook.", "type": "object", "properties": { "comment": { "type": "string" }, "strategy": { "allOf": [ { "$ref": "#/definitions/CloseStrategy" } ], "description": "Defines the strategy for closing the alert and any alerts linked via an associated notebook. If not provided, the default strategy is closeAllLinkedAlerts." } }, "required": [ "comment" ] }, "ClosedWithFurtherActionState": { "type": "object", "properties": { "comment": { "type": "string" }, "closedBy": { "type": "string", "format": "rid", "x-alias": "UserRid" } }, "required": [ "comment", "closedBy" ] }, "CreateDataReviewRequest": { "description": "If commit not is provided, the latest commit on main will be used. Asset RID is required only for multi-asset runs.", "type": "object", "properties": { "runRid": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "assetRid": { "type": "string", "format": "rid", "x-alias": "AssetRid", "description": "Selects asset to execute data review on. Required for multi-asset runs." }, "checklistRid": { "type": "string", "format": "rid", "x-alias": "ChecklistRid" }, "commit": { "type": "string", "x-alias": "CommitId" } }, "required": [ "runRid", "checklistRid" ] }, "DataReview": { "type": "object", "properties": { "rid": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" }, "runRid": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "assetRid": { "type": "string", "format": "rid", "x-alias": "AssetRid" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "checklist": { "allOf": [ { "$ref": "#/definitions/ChecklistEvaluation" } ], "x-deprecated": "This field is deprecated and will be removed in a future version." }, "checklistRef": { "$ref": "#/definitions/PinnedChecklistRef" }, "checkEvaluations": { "type": "array", "items": { "$ref": "#/definitions/AutomaticCheckEvaluation" }, "uniqueItems": true }, "archived": { "type": "boolean" } }, "required": [ "rid", "runRid", "assetRid", "createdAt", "createdBy", "checklistRef", "archived" ] }, "DataReviewCheckMetricsScope": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "runRid", "assetRid", "dataReviewRid" ] }, "runRid": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "assetRid": { "type": "string", "format": "rid", "x-alias": "AssetRid" }, "dataReviewRid": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "runRid", "runRid": "string" } }, "DataReviewPage": { "type": "object", "properties": { "dataReviews": { "type": "array", "items": { "$ref": "#/definitions/DataReview" } }, "nextPageToken": { "type": "string", "x-alias": "Token" } } }, "DuplicateAndLinkNotebook": { "description": "Duplicate the notebook and link the alert to it.", "type": "object", "properties": {} }, "ExecutingState": { "type": "object", "properties": { "jobRid": { "type": "string", "format": "rid", "x-alias": "JobRid" } }, "required": [ "jobRid" ] }, "ExecutionRetriggered": { "type": "object", "properties": { "jobRid": { "type": "string", "format": "rid", "x-alias": "JobRid" } }, "required": [ "jobRid" ] }, "FailedToExecuteState": { "type": "object", "properties": { "jobRid": { "type": "string", "format": "rid", "x-alias": "JobRid" }, "reviewState": { "$ref": "#/definitions/CheckAlertState" }, "reviewNotes": { "type": "string" }, "assigneeRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "uniqueItems": true } }, "required": [ "jobRid" ] }, "FindDataReviewsRequest": { "description": "If both sets are empty, an empty page is returned. If one set is empty, that field is not considered for filtering (like a wildcard). If commitId is omitted from a ChecklistRef, it will match all commits.", "type": "object", "properties": { "runRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "uniqueItems": true }, "assetRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" }, "uniqueItems": true }, "filterByBothRunsAndAssets": { "type": "boolean", "description": "If true, results are filtered to data reviews w/ both run and asset in the requested runs/assets. Defaults to false, where assets are converted to runs and all data reviews under the linked runs (including data reviews on other assets sharing the parent run) will be returned. It is recommended to set this to true and pass in asset RIDs for multi-asset runs. Toggling this option has no effect if no asset RIDs are supplied." }, "checklistRefs": { "type": "array", "items": { "$ref": "#/definitions/ChecklistRef" }, "uniqueItems": true }, "nextPageToken": { "type": "string", "x-alias": "Token" }, "pageSize": { "type": "integer", "format": "int32", "description": "Defaults to 1000. Will throw if larger than 1000." }, "showArchived": { "type": "boolean", "description": "To be deprecated. Use archivedStatuses instead. Allows for inclusion of archived data reviews in search results alongside non-archived ones. Defaults to false if not specified." }, "archivedStatuses": { "type": "array", "items": { "$ref": "#/definitions/ArchivedStatus" }, "uniqueItems": true, "description": "Filters search on data reviews based on the archived statuses provided. Default is NOT_ARCHIVED only if none are provided." } }, "example": { "runRids": [ "" ], "assetRids": [ "" ], "filterByBothRunsAndAssets": true, "checklistRefs": [ { "rid": "" } ], "nextPageToken": "", "pageSize": 1, "showArchived": true, "archivedStatuses": [ "NOT_ARCHIVED" ] } }, "GeneratedAlertsState": { "type": "object", "properties": { "rids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "CheckAlertRid" }, "uniqueItems": true, "x-deprecated": "This field is deprecated and will be removed in a future version. Use eventRids instead." }, "eventRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "EventRid" }, "uniqueItems": true } } }, "GetDataReviewCheckMetricsRequest": { "type": "object", "properties": { "scope": { "$ref": "#/definitions/DataReviewCheckMetricsScope" } }, "required": [ "scope" ], "example": { "scope": { "type": "runRid", "runRid": "" } } }, "GetDataReviewCheckMetricsResponse": { "type": "object", "properties": { "checksPendingExecution": { "type": "integer", "format": "int32" }, "checksExecuting": { "type": "integer", "format": "int32" }, "checksPassed": { "type": "integer", "format": "int32" }, "checksWithEventsPendingReview": { "type": "integer", "format": "int32" }, "checksWithEventsClosedWithIgnore": { "type": "integer", "format": "int32" }, "checksWithEventsClosedWithFurtherAction": { "type": "integer", "format": "int32" }, "checksWithEvents": { "type": "integer", "format": "int32" }, "checksWithTooManyEvents": { "type": "integer", "format": "int32" }, "checksFailedToExecutePendingReview": { "type": "integer", "format": "int32" }, "checksFailedToExecuteClosedWithIgnore": { "type": "integer", "format": "int32" }, "checksFailedToExecuteClosedWithFurtherAction": { "type": "integer", "format": "int32" }, "checksFailedToExecute": { "type": "integer", "format": "int32" }, "checksExecuted": { "type": "integer", "format": "int32" }, "checksTotal": { "type": "integer", "format": "int32" }, "eventsPendingReview": { "type": "integer", "format": "int32" }, "eventsClosedWithIgnore": { "type": "integer", "format": "int32" }, "eventsClosedWithFurtherAction": { "type": "integer", "format": "int32" }, "eventsTotal": { "type": "integer", "format": "int32" } }, "required": [ "checksPendingExecution", "checksExecuting", "checksPassed", "checksWithEventsPendingReview", "checksWithEventsClosedWithIgnore", "checksWithEventsClosedWithFurtherAction", "checksWithEvents", "checksWithTooManyEvents", "checksFailedToExecutePendingReview", "checksFailedToExecuteClosedWithIgnore", "checksFailedToExecuteClosedWithFurtherAction", "checksFailedToExecute", "checksExecuted", "checksTotal", "eventsPendingReview", "eventsClosedWithIgnore", "eventsClosedWithFurtherAction", "eventsTotal" ] }, "HistogramBucket": { "type": "object", "properties": { "startInclusive": { "$ref": "#/definitions/Timestamp" }, "endExclusive": { "$ref": "#/definitions/Timestamp" }, "count": { "type": "integer", "format": "int32" } }, "required": [ "startInclusive", "endExclusive", "count" ] }, "HistogramDistributionVariable": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "startTime" ] }, "startTime": { "$ref": "#/definitions/HistogramStartTimeVariable" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "startTime", "startTime": {} } }, "HistogramPriorityBucket": { "type": "object", "properties": { "startInclusive": { "$ref": "#/definitions/Timestamp" }, "endExclusive": { "$ref": "#/definitions/Timestamp" }, "counts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } }, "required": [ "startInclusive", "endExclusive" ] }, "HistogramPriorityVariable": { "type": "object", "properties": {} }, "HistogramStartTimeVariable": { "type": "object", "properties": {} }, "HistogramStatusBucket": { "type": "object", "properties": { "startInclusive": { "$ref": "#/definitions/Timestamp" }, "endExclusive": { "$ref": "#/definitions/Timestamp" }, "counts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } }, "required": [ "startInclusive", "endExclusive" ] }, "HistogramStatusVariable": { "type": "object", "properties": {} }, "HistogramSubGroupVariable": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "priority", "status" ] }, "priority": { "$ref": "#/definitions/HistogramPriorityVariable" }, "status": { "$ref": "#/definitions/HistogramStatusVariable" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "priority", "priority": {} } }, "LinkNotebook": { "type": "object", "properties": { "rid": { "type": "string", "format": "rid", "x-alias": "NotebookRid" }, "strategy": { "allOf": [ { "$ref": "#/definitions/LinkNotebookStrategy" } ], "description": "Defines the strategy for reconciling the alert with any linked alerts via the associated notebook. If not provided, the alert will be linked naively and throw if it leaves a linked notebook in an invalid state." } }, "required": [ "rid" ] }, "LinkNotebookStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "duplicateAndLinkToNewNotebook", "closeAndLink", "reopenAndLink" ] }, "duplicateAndLinkToNewNotebook": { "$ref": "#/definitions/DuplicateAndLinkNotebook" }, "closeAndLink": { "$ref": "#/definitions/CloseAndLinkToNotebook" }, "reopenAndLink": { "$ref": "#/definitions/ReopenAndLinkToNotebook" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "duplicateAndLinkToNewNotebook", "duplicateAndLinkToNewNotebook": {} } }, "ManualCheckAlertAction": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "pass", "closeWithFurtherAction", "reopen", "reassign", "updateNotes", "linkNotebook" ] }, "pass": { "$ref": "#/definitions/Pass" }, "closeWithFurtherAction": { "$ref": "#/definitions/CloseWithFurtherAction" }, "reopen": { "$ref": "#/definitions/Reopen" }, "reassign": { "$ref": "#/definitions/Reassign" }, "updateNotes": { "$ref": "#/definitions/UpdateNotes" }, "linkNotebook": { "$ref": "#/definitions/LinkNotebook" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "pass", "pass": { "comment": "string" } } }, "ManualCheckEvaluation": { "type": "object", "properties": { "rid": { "type": "string", "format": "rid", "x-alias": "ManualCheckEvaluationRid" }, "checkRid": { "type": "string", "format": "rid", "x-alias": "CheckRid" }, "dataReviewRid": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" }, "state": { "$ref": "#/definitions/ManualCheckEvaluationState" }, "assigneeRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "uniqueItems": true }, "chart": { "allOf": [ { "$ref": "#/definitions/VersionedVizId" } ], "x-deprecated": "charts are no longer versioned resources." }, "notes": { "type": "string" }, "notebook": { "type": "string", "format": "rid", "x-alias": "NotebookRid" } }, "required": [ "rid", "checkRid", "dataReviewRid", "state" ] }, "ManualCheckEvaluationActionLog": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/definitions/ManualCheckEvaluationActionLogEntry" } } } }, "ManualCheckEvaluationActionLogEntry": { "type": "object", "properties": { "performedBy": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "action": { "$ref": "#/definitions/ManualCheckAlertAction" }, "timestamp": { "type": "string", "format": "date-time" } }, "required": [ "performedBy", "action", "timestamp" ] }, "ManualCheckEvaluationState": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "pendingReview", "closedWithFurtherAction", "passing" ] }, "pendingReview": { "$ref": "#/definitions/PendingReviewState" }, "closedWithFurtherAction": { "$ref": "#/definitions/ClosedWithFurtherActionState" }, "passing": { "$ref": "#/definitions/PassState" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "pendingReview", "pendingReview": {} } }, "Pass": { "type": "object", "properties": { "comment": { "type": "string" } }, "required": [ "comment" ] }, "PassState": { "type": "object", "properties": { "comment": { "type": "string" }, "closedBy": { "type": "string", "format": "rid", "x-alias": "UserRid" } }, "required": [ "comment", "closedBy" ] }, "PassingExecutionState": { "type": "object", "properties": {} }, "PendingExecutionState": { "type": "object", "properties": { "jobRid": { "type": "string", "format": "rid", "x-alias": "JobRid" } }, "required": [ "jobRid" ] }, "PendingReviewState": { "type": "object", "properties": {} }, "Reassign": { "type": "object", "properties": { "assigneeRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "uniqueItems": true } } }, "Reopen": { "type": "object", "properties": { "comment": { "type": "string" }, "strategy": { "allOf": [ { "$ref": "#/definitions/ReopenStrategy" } ], "description": "Defines the strategy for reopening the alert and any alerts linked via an associated notebook. If not provided, the default strategy is reopenAllLinkedAlerts." } }, "required": [ "comment" ] }, "ReopenAllLinkedAlerts": { "description": "Reopen all alerts associated with the same notebook and unlock the notebook.", "type": "object", "properties": {} }, "ReopenAndDetachFromNotebook": { "description": "Reopen the alert and detach it from the notebook. If the alert is linked to the same notebook as other alerts, those alerts will maintain the reference to the notebook and the notebook will remain locked.", "type": "object", "properties": {} }, "ReopenAndDuplicatePreviouslyLinkedNotebook": { "description": "Reopen the alert and detach it from the notebook. If the alert is linked to the same notebook as other alerts, the notebook will be duplicated and the alert will be linked to the new notebook. The new notebook will be unlocked.", "type": "object", "properties": {} }, "ReopenAndLinkToNotebook": { "description": "Reopen the alert and link to notebook. Throws if the associated notebook has closed alerts.", "type": "object", "properties": { "comment": { "type": "string" } }, "required": [ "comment" ] }, "ReopenStrategy": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "reopenAllLinkedAlerts", "reopenAndDetachFromNotebook", "reopenAndDuplicatePreviouslyLinkedNotebook" ] }, "reopenAllLinkedAlerts": { "$ref": "#/definitions/ReopenAllLinkedAlerts" }, "reopenAndDetachFromNotebook": { "$ref": "#/definitions/ReopenAndDetachFromNotebook" }, "reopenAndDuplicatePreviouslyLinkedNotebook": { "$ref": "#/definitions/ReopenAndDuplicatePreviouslyLinkedNotebook" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "reopenAllLinkedAlerts", "reopenAllLinkedAlerts": {} } }, "RerunFailedAutomaticChecksRequest": { "type": "object", "properties": { "dataReviewRid": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" } }, "required": [ "dataReviewRid" ], "example": { "dataReviewRid": "" } }, "SearchCheckAlertsRequest": { "type": "object", "properties": { "nextPageToken": { "type": "string", "x-alias": "Token" }, "pageSize": { "type": "integer", "format": "int32", "description": "Defaults to 100. Will throw if larger than 1_000." }, "sortBy": { "allOf": [ { "$ref": "#/definitions/SearchCheckAlertsSortOptions" } ], "description": "If not present, will sort by start time in descending order." }, "searchText": { "type": "string", "description": "Matches on check name" }, "after": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "Filters to start times after this time, inclusive." }, "before": { "allOf": [ { "$ref": "#/definitions/Timestamp" } ], "description": "Filters to start times before this time, exclusive." }, "status": { "type": "array", "items": { "$ref": "#/definitions/CheckAlertStatus" }, "uniqueItems": true }, "checkRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "CheckRid" }, "uniqueItems": true }, "dataReviewRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "DataReviewRid" }, "uniqueItems": true }, "assigneeRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "UserRid" }, "uniqueItems": true }, "priorities": { "type": "array", "items": { "$ref": "#/definitions/Priority" }, "uniqueItems": true }, "runRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "RunRid" }, "uniqueItems": true }, "assetRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "AssetRid" }, "uniqueItems": true }, "pinnedChecklistRefs": { "type": "array", "items": { "$ref": "#/definitions/PinnedChecklistRef" }, "uniqueItems": true }, "chartRids": { "type": "array", "items": { "$ref": "#/definitions/VersionedVizId" }, "uniqueItems": true, "x-deprecated": "charts are no longer versioned resources." }, "notebookRids": { "type": "array", "items": { "type": "string", "format": "rid", "x-alias": "NotebookRid" }, "uniqueItems": true }, "showArchived": { "type": "boolean", "description": "To be deprecated. Use archivedStatuses instead. If true, includes archived check alerts in the search results. If not present or false, will not show archived data reviews in search results" }, "archivedStatuses": { "type": "array", "items": { "$ref": "#/definitions/ArchivedStatus" }, "uniqueItems": true, "description": "Filters search on check alerts based on the archived statuses provided. Default is NOT_ARCHIVED only if none are provided." } }, "example": { "nextPageToken": "", "pageSize": 1, "sortBy": { "isDescending": true, "field": "CHECK_NAME" }, "searchText": "", "after": { "seconds": 1, "nanos": 1 }, "before": { "seconds": 1, "nanos": 1 }, "status": [ "PENDING_REVIEW" ], "checkRids": [ "" ], "dataReviewRids": [ "" ], "assigneeRids": [ "" ], "priorities": [ "P0" ], "runRids": [ "" ], "assetRids": [ "" ], "pinnedChecklistRefs": [ { "rid": "", "commit": "" } ], "chartRids": [ { "rid": "", "version": 1 } ], "notebookRids": [ "" ], "showArchived": true, "archivedStatuses": [ "NOT_ARCHIVED" ] } }, "SearchCheckAlertsResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "x-alias": "Token" }, "checkAlerts": { "type": "array", "items": { "$ref": "#/definitions/CheckAlert" } } } }, "SearchCheckAlertsSortField": { "type": "string", "enum": [ "CHECK_NAME", "START", "END", "STATUS", "PRIORITY", "DURATION" ] }, "SearchCheckAlertsSortOptions": { "type": "object", "properties": { "isDescending": { "type": "boolean" }, "field": { "$ref": "#/definitions/SearchCheckAlertsSortField" } }, "required": [ "isDescending", "field" ] }, "Status": { "type": "string", "enum": [ "PASS", "FAIL" ] }, "TooManyAlertsState": { "description": "The number of generated alerts is greater than the maximum. The check is likely misconfigured.", "type": "object", "properties": {} }, "UnarchiveDataReview": { "description": "Unarchive the data review which created this check alert. Only performable via the unarchive data review endpoint; not supported by Perform Check Alert Action.", "type": "object", "properties": {} }, "UnlinkNotebook": { "type": "object", "properties": {} }, "UpdateNotes": { "type": "object", "properties": { "notes": { "type": "string" } }, "required": [ "notes" ] }, "NotificationConfiguration": { "description": "Configuration details to send notifications to a linked integration.", "type": "object", "properties": { "integrationRid": { "type": "string", "format": "rid", "x-alias": "IntegrationRid" }, "notificationFilters": { "type": "array", "items": { "$ref": "#/definitions/NotificationFilter" }, "uniqueItems": true, "description": "Specifies the type of notifications to filter. If not provided, all notifications are sent." }, "appendedWorkbookRid": { "type": "string", "format": "rid", "x-alias": "NotebookRid", "description": "If provided, appends a link to the workbook specified by the RID to the notification." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "20 tags max, 50 characters max each. Tags are used to filter messages in Opsgenie. For other integrations, tags are ignored." }, "muteUntil": { "type": "string", "format": "date-time", "description": "If provided, all notifications for this channel are suppressed until the specified time. The streaming checklist continues to evaluate, but no notifications are sent. Once the time has passed, notifications resume automatically." } }, "required": [ "integrationRid" ] }, "NotificationFilter": { "description": "Specifies a type of notification to filter.", "type": "string", "enum": [ "EXECUTION_ERROR" ] }, "CheckAlertState": { "type": "object", "x-union": true, "properties": { "type": { "type": "string", "enum": [ "pendingReview", "closedWithFurtherAction", "closedWithIgnore" ] }, "pendingReview": { "$ref": "#/definitions/PendingReviewAlertState" }, "closedWithFurtherAction": { "$ref": "#/definitions/ClosedWithFurtherActionAlertState" }, "closedWithIgnore": { "$ref": "#/definitions/ClosedWithIgnoreAlertState" } }, "required": [ "type" ], "description": "Set `type` to the name of one of the other fields, and set only that field.", "example": { "type": "pendingReview", "pendingReview": {} } }, "ClosedWithFurtherActionAlertState": { "type": "object", "properties": { "comment": { "type": "string" }, "closedBy": { "type": "string", "format": "rid", "x-alias": "UserRid" } }, "required": [ "comment", "closedBy" ] }, "ClosedWithIgnoreAlertState": { "type": "object", "properties": { "comment": { "type": "string" }, "closedBy": { "type": "string", "format": "rid", "x-alias": "UserRid" } }, "required": [ "comment", "closedBy" ] }, "PendingReviewAlertState": { "type": "object", "properties": {} }, "VersionedVizId": { "type": "object", "properties": { "rid": { "type": "string", "x-alias": "VizId" }, "version": { "type": "integer", "format": "int32", "x-alias": "Version" } }, "required": [ "rid", "version" ] } }, "tags": [ { "name": "Data Review Service", "x-displayName": "Data review service", "description": "The data review service manages the evaluation, disposition, and historical record of checks alerts.", "x-errors": [ { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:FailedToResolveSeriesForCheck" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:NoPointsInRange" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "Checks:ChecklistsNotFound" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:ReviewCommentIsEmpty" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "DataReview:DataReviewNotFound" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "DataReview:DataReviewsNotFound" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:AutomaticCheckEvaluationNotFound" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:AutomaticCheckEvaluationsNotFound" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:ManualCheckEvaluationNotFound" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:ManualCheckEvaluationsNotFound" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "Checks:RunsNotFound" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "Checks:AssetsNotFound" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:InvalidPageToken" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:CheckAlertNotFound" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "DataReview:CheckAlertsNotFound" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "DataReview:NotebooksNotFound" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "DataReview:LinkedDataReviewsNotFound" }, { "status": 404, "errorCode": "NOT_FOUND", "errorName": "DataReview:LinkedNotebooksNotFound" }, { "status": 500, "errorCode": "INTERNAL", "errorName": "DataReview:FailedToPerformCheckAlertAction" }, { "status": 400, "errorCode": "INVALID_ARGUMENT", "errorName": "DataReview:CannotPerformCheckAlertAction" }, { "status": 500, "errorCode": "INTERNAL", "errorName": "DataReview:FailedToPerformAutomaticCheckEvaluationReviewAction" } ] } ] }