Data review service#

The data review service manages the evaluation, disposition, and historical record of checks alerts.

OpenAPI file: DataReviewService.json

Endpoints#

Batch initiate#

POST /scout/v2/data-review/batch-initiate

For each request, initiates data review for the requested run and checklist and executes the automatic checks against the run.

Body

requests array of CreateDataReviewRequest

​

Fields of CreateDataReviewRequest
runRid string (RID) required

​

assetRid string (RID)

Selects asset to execute data review on. Required for multi-asset runs.

checklistRid string (RID) required

​

commit string

​

notificationConfigurations array of NotificationConfiguration

If provided, checklist violations will be sent to the specified integrations.

Fields of NotificationConfiguration
integrationRid string (RID) required

​

notificationFilters array of NotificationFilter

Specifies the type of notifications to filter. If not provided, all notifications are sent.

Values of NotificationFilter
EXECUTION_ERROR

​

appendedWorkbookRid string (RID)

If provided, appends a link to the workbook specified by the RID to the notification.

tags array of string

20 tags max, 50 characters max each. Tags are used to filter messages in Opsgenie. For other integrations, tags are ignored.

muteUntil string (date-time)

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.

Response

rids array of string (RID)

​

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/batch-initiate" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "requests": [
    {
      "runRid": "<run rid>",
      "checklistRid": "<checklist rid>"
    }
  ],
  "notificationConfigurations": [
    {
      "integrationRid": "<integration rid>"
    }
  ]
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/batch-initiate",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "requests": [{"runRid": "<run rid>", "checklistRid": "<checklist rid>"}],
        "notificationConfigurations": [{"integrationRid": "<integration rid>"}],
    },
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/batch-initiate",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "requests": [{"runRid": "<run rid>", "checklistRid": "<checklist rid>"}],
        "notificationConfigurations": [{"integrationRid": "<integration rid>"}],
    },
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/batch-initiate",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "requests": [{"runRid": "<run rid>", "checklistRid": "<checklist rid>"}],
                "notificationConfigurations": [{"integrationRid": "<integration rid>"}],
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "rids": [
    "<data review rid>"
  ]
}

Rerun failed automatic checks#

POST /scout/v2/data-review/rerun-failed-automatic-checks

Re-executes the most recent failed automatic checks for the data review.

Body

dataReviewRid string (RID) required

​

Response

No content (HTTP 204).

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/rerun-failed-automatic-checks" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "dataReviewRid": "<data review rid>"
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/rerun-failed-automatic-checks",
    headers={"Authorization": "Bearer <api key>"},
    json={"dataReviewRid": "<data review rid>"},
)
response.raise_for_status()

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/rerun-failed-automatic-checks",
    headers={"Authorization": "Bearer <api key>"},
    json={"dataReviewRid": "<data review rid>"},
)
response.raise_for_status()

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/rerun-failed-automatic-checks",
            headers={"Authorization": "Bearer <api key>"},
            json={"dataReviewRid": "<data review rid>"},
        ) as response:
            response.raise_for_status()


asyncio.run(main())

Response: 204

No content.

Find data reviews#

POST /scout/v2/data-review/search

Returns the data reviews under the provided search parameters.

Body

runRids array of string (RID)

​

assetRids array of string (RID)

​

filterByBothRunsAndAssets boolean

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 array of ChecklistRef

​

Fields of ChecklistRef
rid string (RID) required

​

commit string

​

nextPageToken string

​

pageSize integer

Defaults to 1000. Will throw if larger than 1000.

showArchived boolean

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 array of ArchivedStatus

Filters search on data reviews based on the archived statuses provided. Default is NOT_ARCHIVED only if none are provided.

Values of ArchivedStatus
NOT_ARCHIVED

​

ARCHIVED

​

Response

dataReviews array of DataReview

​

Fields of DataReview
rid string (RID)

​

runRid string (RID)

​

assetRid string (RID)

​

createdAt string (date-time)

​

createdBy string (RID)

​

checklist ChecklistEvaluation deprecated

Deprecated: This field is deprecated and will be removed in a future version.

Fields of ChecklistEvaluation
checklist PinnedChecklistRef

​

Fields of PinnedChecklistRef
rid string (RID)

​

commit string

​

dataReviewRid string (RID)

​

checks array of CheckEvaluation

​

Set type to "automaticCheck".

automaticCheck AutomaticCheckEvaluation

​

Fields of AutomaticCheckEvaluation
rid string (RID)

​

checkRid string (RID)

​

checkImplementationIndex integer

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 string (RID)

​

state AutomaticCheckEvaluationState

​

Set type to "pendingExecution".

pendingExecution PendingExecutionState

​

Fields of PendingExecutionState
jobRid string (RID)

​

Set type to "failedToExecute".

failedToExecute FailedToExecuteState

​

Fields of FailedToExecuteState
jobRid string (RID)

​

reviewState CheckAlertState

​

Set type to "pendingReview".

pendingReview PendingReviewAlertState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

Fields of ClosedWithFurtherActionAlertState
comment string

​

closedBy string (RID)

​

Set type to "closedWithIgnore".

closedWithIgnore ClosedWithIgnoreAlertState

​

Fields of ClosedWithIgnoreAlertState
comment string

​

closedBy string (RID)

​

reviewNotes string

​

assigneeRids array of string (RID)

​

Set type to "passing".

passing PassingExecutionState

​

Set type to "generatedAlerts".

generatedAlerts GeneratedAlertsState

​

Fields of GeneratedAlertsState
rids array of string (RID) deprecated

Deprecated: This field is deprecated and will be removed in a future version. Use eventRids instead.

eventRids array of string (RID)

​

Set type to "tooManyAlerts".

tooManyAlerts TooManyAlertsState

​

Set type to "executing".

executing ExecutingState

​

Fields of ExecutingState
jobRid string (RID)

​

Set type to "manualCheck".

manualCheck ManualCheckEvaluation

​

Fields of ManualCheckEvaluation
rid string (RID)

​

checkRid string (RID)

​

dataReviewRid string (RID)

​

state ManualCheckEvaluationState

​

Set type to "pendingReview".

pendingReview PendingReviewState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionState

​

Fields of ClosedWithFurtherActionState
comment string

​

closedBy string (RID)

​

Set type to "passing".

passing PassState

​

Fields of PassState
comment string

​

closedBy string (RID)

​

assigneeRids array of string (RID)

​

chart VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

Fields of VersionedVizId
rid string

​

version integer

​

notes string

​

notebook string (RID)

​

checklistRef PinnedChecklistRef

​

checkEvaluations array of AutomaticCheckEvaluation

​

archived boolean

​

nextPageToken string

​

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/search" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "runRids": [
    "<run rid>"
  ],
  "assetRids": [
    "<asset rid>"
  ],
  "filterByBothRunsAndAssets": true,
  "checklistRefs": [
    {
      "rid": "<checklist rid>"
    }
  ],
  "nextPageToken": "<token>",
  "pageSize": 1,
  "showArchived": true,
  "archivedStatuses": [
    "NOT_ARCHIVED"
  ]
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/search",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "runRids": ["<run rid>"],
        "assetRids": ["<asset rid>"],
        "filterByBothRunsAndAssets": True,
        "checklistRefs": [{"rid": "<checklist rid>"}],
        "nextPageToken": "<token>",
        "pageSize": 1,
        "showArchived": True,
        "archivedStatuses": ["NOT_ARCHIVED"],
    },
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/search",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "runRids": ["<run rid>"],
        "assetRids": ["<asset rid>"],
        "filterByBothRunsAndAssets": True,
        "checklistRefs": [{"rid": "<checklist rid>"}],
        "nextPageToken": "<token>",
        "pageSize": 1,
        "showArchived": True,
        "archivedStatuses": ["NOT_ARCHIVED"],
    },
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/search",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "runRids": ["<run rid>"],
                "assetRids": ["<asset rid>"],
                "filterByBothRunsAndAssets": True,
                "checklistRefs": [{"rid": "<checklist rid>"}],
                "nextPageToken": "<token>",
                "pageSize": 1,
                "showArchived": True,
                "archivedStatuses": ["NOT_ARCHIVED"],
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "dataReviews": [
    {
      "rid": "<data review rid>",
      "runRid": "<run rid>",
      "assetRid": "<asset rid>",
      "createdAt": "2026-01-01T00:00:00Z",
      "createdBy": "<user rid>",
      "checklist": {
        "checklist": {
          "rid": "<checklist rid>",
          "commit": "<commit id>"
        },
        "dataReviewRid": "<data review rid>",
        "checks": [
          {
            "type": "automaticCheck",
            "automaticCheck": {
              "rid": "<automatic check evaluation rid>",
              "checkRid": "<check rid>",
              "checkImplementationIndex": 1,
              "dataReviewRid": "<data review rid>",
              "state": {
                "type": "pendingExecution",
                "pendingExecution": {
                  "jobRid": "<job rid>"
                }
              }
            }
          }
        ]
      },
      "checklistRef": {
        "rid": "<checklist rid>",
        "commit": "<commit id>"
      },
      "checkEvaluations": [
        {
          "rid": "<automatic check evaluation rid>",
          "checkRid": "<check rid>",
          "checkImplementationIndex": 1,
          "dataReviewRid": "<data review rid>",
          "state": {
            "type": "pendingExecution",
            "pendingExecution": {
              "jobRid": "<job rid>"
            }
          }
        }
      ],
      "archived": true
    }
  ],
  "nextPageToken": "<token>"
}

Get#

GET /scout/v2/data-review/{dataReviewRid}

Throws if not found.

Path parameters

dataReviewRid string (RID) required

​

Response

rid string (RID)

​

runRid string (RID)

​

assetRid string (RID)

​

createdAt string (date-time)

​

createdBy string (RID)

​

checklist ChecklistEvaluation deprecated

Deprecated: This field is deprecated and will be removed in a future version.

Fields of ChecklistEvaluation
checklist PinnedChecklistRef

​

Fields of PinnedChecklistRef
rid string (RID)

​

commit string

​

dataReviewRid string (RID)

​

checks array of CheckEvaluation

​

Set type to "automaticCheck".

automaticCheck AutomaticCheckEvaluation

​

Fields of AutomaticCheckEvaluation
rid string (RID)

​

checkRid string (RID)

​

checkImplementationIndex integer

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 string (RID)

​

state AutomaticCheckEvaluationState

​

Set type to "pendingExecution".

pendingExecution PendingExecutionState

​

Fields of PendingExecutionState
jobRid string (RID)

​

Set type to "failedToExecute".

failedToExecute FailedToExecuteState

​

Fields of FailedToExecuteState
jobRid string (RID)

​

reviewState CheckAlertState

​

Set type to "pendingReview".

pendingReview PendingReviewAlertState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

Fields of ClosedWithFurtherActionAlertState
comment string

​

closedBy string (RID)

​

Set type to "closedWithIgnore".

closedWithIgnore ClosedWithIgnoreAlertState

​

Fields of ClosedWithIgnoreAlertState
comment string

​

closedBy string (RID)

​

reviewNotes string

​

assigneeRids array of string (RID)

​

Set type to "passing".

passing PassingExecutionState

​

Set type to "generatedAlerts".

generatedAlerts GeneratedAlertsState

​

Fields of GeneratedAlertsState
rids array of string (RID) deprecated

Deprecated: This field is deprecated and will be removed in a future version. Use eventRids instead.

eventRids array of string (RID)

​

Set type to "tooManyAlerts".

tooManyAlerts TooManyAlertsState

​

Set type to "executing".

executing ExecutingState

​

Fields of ExecutingState
jobRid string (RID)

​

Set type to "manualCheck".

manualCheck ManualCheckEvaluation

​

Fields of ManualCheckEvaluation
rid string (RID)

​

checkRid string (RID)

​

dataReviewRid string (RID)

​

state ManualCheckEvaluationState

​

Set type to "pendingReview".

pendingReview PendingReviewState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionState

​

Fields of ClosedWithFurtherActionState
comment string

​

closedBy string (RID)

​

Set type to "passing".

passing PassState

​

Fields of PassState
comment string

​

closedBy string (RID)

​

assigneeRids array of string (RID)

​

chart VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

Fields of VersionedVizId
rid string

​

version integer

​

notes string

​

notebook string (RID)

​

checklistRef PinnedChecklistRef

​

checkEvaluations array of AutomaticCheckEvaluation

​

archived boolean

​

Request

curl "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.get(
            "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "rid": "<data review rid>",
  "runRid": "<run rid>",
  "assetRid": "<asset rid>",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "<user rid>",
  "checklist": {
    "checklist": {
      "rid": "<checklist rid>",
      "commit": "<commit id>"
    },
    "dataReviewRid": "<data review rid>",
    "checks": [
      {
        "type": "automaticCheck",
        "automaticCheck": {
          "rid": "<automatic check evaluation rid>",
          "checkRid": "<check rid>",
          "checkImplementationIndex": 1,
          "dataReviewRid": "<data review rid>",
          "state": {
            "type": "pendingExecution",
            "pendingExecution": {
              "jobRid": "<job rid>"
            }
          }
        }
      }
    ]
  },
  "checklistRef": {
    "rid": "<checklist rid>",
    "commit": "<commit id>"
  },
  "checkEvaluations": [
    {
      "rid": "<automatic check evaluation rid>",
      "checkRid": "<check rid>",
      "checkImplementationIndex": 1,
      "dataReviewRid": "<data review rid>",
      "state": {
        "type": "pendingExecution",
        "pendingExecution": {
          "jobRid": "<job rid>"
        }
      }
    }
  ],
  "archived": true
}

Get check alert#

GET /scout/v2/data-review/check-alerts/{checkAlertRid}

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Throws if not found.

Path parameters

checkAlertRid string (RID) required

​

Response

rid string (RID)

​

checkRid string (RID)

​

implementationIndex integer

​

dataReviewRid string (RID)

​

checkEvaluationRid string (RID)

​

name string

​

autogeneratedCheckTitle string

​

autogeneratedCheckDescription string

​

assigneeRids array of string (RID)

​

start Timestamp

​

Fields of Timestamp
seconds integer (int64)

​

nanos integer (int64)

​

end Timestamp

​

state CheckAlertState

​

Set type to "pendingReview".

pendingReview PendingReviewAlertState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

Fields of ClosedWithFurtherActionAlertState
comment string

​

closedBy string (RID)

​

Set type to "closedWithIgnore".

closedWithIgnore ClosedWithIgnoreAlertState

​

Fields of ClosedWithIgnoreAlertState
comment string

​

closedBy string (RID)

​

priority Priority

​

Values of Priority
P0

​

P1

​

P2

​

P3

​

P4

​

chart VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

Fields of VersionedVizId
rid string

​

version integer

​

notes string

​

notebook string (RID)

​

Request

curl "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.get(
            "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "rid": "<check alert rid>",
  "checkRid": "<check rid>",
  "implementationIndex": 1,
  "dataReviewRid": "<data review rid>",
  "checkEvaluationRid": "<automatic check evaluation rid>",
  "name": "<name>",
  "autogeneratedCheckTitle": "<autogenerated check title>",
  "autogeneratedCheckDescription": "<autogenerated check description>",
  "assigneeRids": [
    "<user rid>"
  ],
  "start": {
    "seconds": 1,
    "nanos": 1
  },
  "end": {
    "seconds": 1,
    "nanos": 1
  },
  "state": {
    "type": "pendingReview",
    "pendingReview": {}
  },
  "priority": "P0",
  "chart": {
    "rid": "<viz id>",
    "version": 1
  },
  "notes": "<notes>",
  "notebook": "<notebook rid>"
}

Perform check alert action#

PUT /scout/v2/data-review/check-alerts/{checkAlertRid}

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Applies a check alert action to the specified check alert RID.

Path parameters

checkAlertRid string (RID) required

​

Body

A CheckAlertAction union.

Set type to "closeWithIgnore".

closeWithIgnore CloseWithIgnoreAlert

​

Fields of CloseWithIgnoreAlert
comment string required

​

strategy CloseStrategy

Defines the strategy for closing the alert and any alerts linked via an associated notebook. If not provided, the default strategy is closeAllLinkedAlerts.

Set type to "closeAllLinkedAlerts".

closeAllLinkedAlerts CloseAllLinkedAlerts

​

Set type to "closeAndDetachFromNotebook".

closeAndDetachFromNotebook CloseAndDetachFromNotebook

​

Set type to "closeAndDuplicatePreviouslyLinkedNotebook".

closeAndDuplicatePreviouslyLinkedNotebook CloseAndDuplicatePreviouslyLinkedNotebook

​

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Fields of CloseWithFurtherAction
comment string required

​

strategy CloseStrategy

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.

Set type to "reopen".

reopen Reopen

​

Fields of Reopen
comment string required

​

strategy ReopenStrategy

Defines the strategy for reopening the alert and any alerts linked via an associated notebook. If not provided, the default strategy is reopenAllLinkedAlerts.

Set type to "reopenAllLinkedAlerts".

reopenAllLinkedAlerts ReopenAllLinkedAlerts

​

Set type to "reopenAndDetachFromNotebook".

reopenAndDetachFromNotebook ReopenAndDetachFromNotebook

​

Set type to "reopenAndDuplicatePreviouslyLinkedNotebook".

reopenAndDuplicatePreviouslyLinkedNotebook ReopenAndDuplicatePreviouslyLinkedNotebook

​

Set type to "reassign".

reassign Reassign

​

Fields of Reassign
assigneeRids array of string (RID)

​

Set type to "updateNotes".

updateNotes UpdateNotes

​

Fields of UpdateNotes
notes string required

​

Set type to "linkNotebook".

linkNotebook LinkNotebook

​

Fields of LinkNotebook
rid string (RID) required

​

strategy LinkNotebookStrategy

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.

Set type to "duplicateAndLinkToNewNotebook".

duplicateAndLinkToNewNotebook DuplicateAndLinkNotebook

​

Set type to "closeAndLink".

closeAndLink CloseAndLinkToNotebook

​

Fields of CloseAndLinkToNotebook
closeAction CloseAction required

​

Set type to "closeWithIgnore".

closeWithIgnore CloseWithIgnoreAlert

​

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Set type to "reopenAndLink".

reopenAndLink ReopenAndLinkToNotebook

​

Fields of ReopenAndLinkToNotebook
comment string required

​

Set type to "unlinkNotebook".

unlinkNotebook UnlinkNotebook

​

Set type to "archiveDataReview".

archiveDataReview ArchiveDataReview

​

Set type to "unarchiveDataReview".

unarchiveDataReview UnarchiveDataReview

​

Response

rid string (RID)

​

checkRid string (RID)

​

implementationIndex integer

​

dataReviewRid string (RID)

​

checkEvaluationRid string (RID)

​

name string

​

autogeneratedCheckTitle string

​

autogeneratedCheckDescription string

​

assigneeRids array of string (RID)

​

start Timestamp

​

Fields of Timestamp
seconds integer (int64)

​

nanos integer (int64)

​

end Timestamp

​

state CheckAlertState

​

Set type to "pendingReview".

pendingReview PendingReviewAlertState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

Fields of ClosedWithFurtherActionAlertState
comment string

​

closedBy string (RID)

​

Set type to "closedWithIgnore".

closedWithIgnore ClosedWithIgnoreAlertState

​

Fields of ClosedWithIgnoreAlertState
comment string

​

closedBy string (RID)

​

priority Priority

​

Values of Priority
P0

​

P1

​

P2

​

P3

​

P4

​

chart VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

Fields of VersionedVizId
rid string

​

version integer

​

notes string

​

notebook string (RID)

​

Request

curl -X PUT "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "type": "closeWithIgnore",
  "closeWithIgnore": {
    "comment": "<comment>"
  }
}'

import requests

response = requests.put(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>",
    headers={"Authorization": "Bearer <api key>"},
    json={"type": "closeWithIgnore", "closeWithIgnore": {"comment": "<comment>"}},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.put(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>",
    headers={"Authorization": "Bearer <api key>"},
    json={"type": "closeWithIgnore", "closeWithIgnore": {"comment": "<comment>"}},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.put(
            "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "type": "closeWithIgnore",
                "closeWithIgnore": {"comment": "<comment>"},
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "rid": "<check alert rid>",
  "checkRid": "<check rid>",
  "implementationIndex": 1,
  "dataReviewRid": "<data review rid>",
  "checkEvaluationRid": "<automatic check evaluation rid>",
  "name": "<name>",
  "autogeneratedCheckTitle": "<autogenerated check title>",
  "autogeneratedCheckDescription": "<autogenerated check description>",
  "assigneeRids": [
    "<user rid>"
  ],
  "start": {
    "seconds": 1,
    "nanos": 1
  },
  "end": {
    "seconds": 1,
    "nanos": 1
  },
  "state": {
    "type": "pendingReview",
    "pendingReview": {}
  },
  "priority": "P0",
  "chart": {
    "rid": "<viz id>",
    "version": 1
  },
  "notes": "<notes>",
  "notebook": "<notebook rid>"
}

Get check alerts for data review#

GET /scout/v2/data-review/{dataReviewRid}/check-alerts

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Gets all check alerts from the provided data review.

Path parameters

dataReviewRid string (RID) required

​

Response

The body is an array of CheckAlert.

Fields of CheckAlert
rid string (RID)

​

checkRid string (RID)

​

implementationIndex integer

​

dataReviewRid string (RID)

​

checkEvaluationRid string (RID)

​

name string

​

autogeneratedCheckTitle string

​

autogeneratedCheckDescription string

​

assigneeRids array of string (RID)

​

start Timestamp

​

Fields of Timestamp
seconds integer (int64)

​

nanos integer (int64)

​

end Timestamp

​

state CheckAlertState

​

Set type to "pendingReview".

pendingReview PendingReviewAlertState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

Fields of ClosedWithFurtherActionAlertState
comment string

​

closedBy string (RID)

​

Set type to "closedWithIgnore".

closedWithIgnore ClosedWithIgnoreAlertState

​

Fields of ClosedWithIgnoreAlertState
comment string

​

closedBy string (RID)

​

priority Priority

​

Values of Priority
P0

​

P1

​

P2

​

P3

​

P4

​

chart VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

Fields of VersionedVizId
rid string

​

version integer

​

notes string

​

notebook string (RID)

​

Request

curl "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>/check-alerts" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>/check-alerts",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>/check-alerts",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.get(
            "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>/check-alerts",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

[
  {
    "rid": "<check alert rid>",
    "checkRid": "<check rid>",
    "implementationIndex": 1,
    "dataReviewRid": "<data review rid>",
    "checkEvaluationRid": "<automatic check evaluation rid>",
    "name": "<name>",
    "autogeneratedCheckTitle": "<autogenerated check title>",
    "autogeneratedCheckDescription": "<autogenerated check description>",
    "assigneeRids": [
      "<user rid>"
    ],
    "start": {
      "seconds": 1,
      "nanos": 1
    },
    "end": {
      "seconds": 1,
      "nanos": 1
    },
    "state": {
      "type": "pendingReview",
      "pendingReview": {}
    },
    "priority": "P0",
    "chart": {
      "rid": "<viz id>",
      "version": 1
    },
    "notes": "<notes>",
    "notebook": "<notebook rid>"
  }
]

Get check alerts histogram#

POST /scout/v2/data-review/check-alerts/histogram

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns a histogram of alerts that occur across the provided runs or assets. At least one run or asset must be specified.

Body

numBins integer

Defaults to 100. Throws if larger than 1_000.

searchText string

Matches on check name

distributionVariable HistogramDistributionVariable required

Represents the data points on the x-axis of a histogram.

Set type to "startTime".

startTime HistogramStartTimeVariable

​

subGroupVariable HistogramSubGroupVariable

The variable that divides the data into distinct groups for comparison within the histogram.

Set type to "priority".

priority HistogramPriorityVariable

​

Set type to "status".

status HistogramStatusVariable

​

startTimeAfter Timestamp required

Filters to start times after this time, inclusive.

Fields of Timestamp
seconds integer (int64) required

​

nanos integer (int64) required

​

startTimeBefore Timestamp required

Filters to start times before this time, exclusive.

status array of CheckAlertStatus

​

Values of CheckAlertStatus
PENDING_REVIEW

​

CLOSED_IGNORED

​

CLOSED_REQUIRES_FURTHER_ACTION

​

checkRids array of string (RID)

​

dataReviewRids array of string (RID)

​

assigneeRids array of string (RID)

​

priorities array of Priority

​

Values of Priority
P0

​

P1

​

P2

​

P3

​

P4

​

runRids array of string (RID)

​

assetRids array of string (RID)

​

pinnedChecklistRefs array of PinnedChecklistRef

​

Fields of PinnedChecklistRef
rid string (RID) required

​

commit string required

​

chartRids array of VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

Fields of VersionedVizId
rid string required

​

version integer required

​

notebookRids array of string (RID)

​

showArchived boolean

To be deprecated. Use archivedStatuses instead. If not present, will not show archived data reviews in search results.

archivedStatuses array of ArchivedStatus

Filters search on check alerts based on the archived statuses provided. Default is NOT_ARCHIVED only if none are provided.

Values of ArchivedStatus
NOT_ARCHIVED

​

ARCHIVED

​

Response

buckets CheckAlertsHistogramBuckets

​

Set type to "unstacked".

unstacked CheckAlertsUnstackedHistogram

​

Fields of CheckAlertsUnstackedHistogram
buckets array of HistogramBucket

​

Fields of HistogramBucket
startInclusive Timestamp

​

Fields of Timestamp
seconds integer (int64)

​

nanos integer (int64)

​

endExclusive Timestamp

​

count integer

​

Set type to "priority".

priority CheckAlertsPriorityHistogram

​

Fields of CheckAlertsPriorityHistogram
buckets array of HistogramPriorityBucket

​

Fields of HistogramPriorityBucket
startInclusive Timestamp

​

endExclusive Timestamp

​

counts map of string to integer

​

Set type to "status".

status CheckAlertsStatusHistogram

​

Fields of CheckAlertsStatusHistogram
buckets array of HistogramStatusBucket

​

Fields of HistogramStatusBucket
startInclusive Timestamp

​

endExclusive Timestamp

​

counts map of string to integer

​

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/histogram" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "distributionVariable": {
    "type": "startTime",
    "startTime": {}
  },
  "startTimeAfter": {
    "seconds": 1,
    "nanos": 1
  },
  "startTimeBefore": {
    "seconds": 1,
    "nanos": 1
  }
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/histogram",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "distributionVariable": {"type": "startTime", "startTime": {}},
        "startTimeAfter": {"seconds": 1, "nanos": 1},
        "startTimeBefore": {"seconds": 1, "nanos": 1},
    },
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/histogram",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "distributionVariable": {"type": "startTime", "startTime": {}},
        "startTimeAfter": {"seconds": 1, "nanos": 1},
        "startTimeBefore": {"seconds": 1, "nanos": 1},
    },
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/histogram",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "distributionVariable": {"type": "startTime", "startTime": {}},
                "startTimeAfter": {"seconds": 1, "nanos": 1},
                "startTimeBefore": {"seconds": 1, "nanos": 1},
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "buckets": {
    "type": "unstacked",
    "unstacked": {
      "buckets": [
        {
          "startInclusive": {
            "seconds": 1,
            "nanos": 1
          },
          "endExclusive": {
            "seconds": 1,
            "nanos": 1
          },
          "count": 1
        }
      ]
    }
  }
}

Search check alerts#

POST /scout/v2/data-review/check-alerts

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns the check alerts under the provided search parameters. At least one run or asset must be specified.

Body

nextPageToken string

​

pageSize integer

Defaults to 100. Will throw if larger than 1_000.

sortBy SearchCheckAlertsSortOptions

If not present, will sort by start time in descending order.

Fields of SearchCheckAlertsSortOptions
isDescending boolean required

​

field SearchCheckAlertsSortField required

​

Values of SearchCheckAlertsSortField
CHECK_NAME

​

START

​

END

​

STATUS

​

PRIORITY

​

DURATION

​

searchText string

Matches on check name

after Timestamp

Filters to start times after this time, inclusive.

Fields of Timestamp
seconds integer (int64) required

​

nanos integer (int64) required

​

before Timestamp

Filters to start times before this time, exclusive.

status array of CheckAlertStatus

​

Values of CheckAlertStatus
PENDING_REVIEW

​

CLOSED_IGNORED

​

CLOSED_REQUIRES_FURTHER_ACTION

​

checkRids array of string (RID)

​

dataReviewRids array of string (RID)

​

assigneeRids array of string (RID)

​

priorities array of Priority

​

Values of Priority
P0

​

P1

​

P2

​

P3

​

P4

​

runRids array of string (RID)

​

assetRids array of string (RID)

​

pinnedChecklistRefs array of PinnedChecklistRef

​

Fields of PinnedChecklistRef
rid string (RID) required

​

commit string required

​

chartRids array of VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

Fields of VersionedVizId
rid string required

​

version integer required

​

notebookRids array of string (RID)

​

showArchived boolean

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 array of ArchivedStatus

Filters search on check alerts based on the archived statuses provided. Default is NOT_ARCHIVED only if none are provided.

Values of ArchivedStatus
NOT_ARCHIVED

​

ARCHIVED

​

Response

nextPageToken string

​

checkAlerts array of CheckAlert

​

Fields of CheckAlert
rid string (RID)

​

checkRid string (RID)

​

implementationIndex integer

​

dataReviewRid string (RID)

​

checkEvaluationRid string (RID)

​

name string

​

autogeneratedCheckTitle string

​

autogeneratedCheckDescription string

​

assigneeRids array of string (RID)

​

start Timestamp

​

Fields of Timestamp
seconds integer (int64)

​

nanos integer (int64)

​

end Timestamp

​

state CheckAlertState

​

Set type to "pendingReview".

pendingReview PendingReviewAlertState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

Fields of ClosedWithFurtherActionAlertState
comment string

​

closedBy string (RID)

​

Set type to "closedWithIgnore".

closedWithIgnore ClosedWithIgnoreAlertState

​

Fields of ClosedWithIgnoreAlertState
comment string

​

closedBy string (RID)

​

priority Priority

​

Values of Priority
P0

​

P1

​

P2

​

P3

​

P4

​

chart VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

Fields of VersionedVizId
rid string

​

version integer

​

notes string

​

notebook string (RID)

​

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "nextPageToken": "<token>",
  "pageSize": 1,
  "sortBy": {
    "isDescending": true,
    "field": "CHECK_NAME"
  },
  "searchText": "<search text>",
  "after": {
    "seconds": 1,
    "nanos": 1
  },
  "before": {
    "seconds": 1,
    "nanos": 1
  },
  "status": [
    "PENDING_REVIEW"
  ],
  "checkRids": [
    "<check rid>"
  ],
  "dataReviewRids": [
    "<data review rid>"
  ],
  "assigneeRids": [
    "<user rid>"
  ],
  "priorities": [
    "P0"
  ],
  "runRids": [
    "<run rid>"
  ],
  "assetRids": [
    "<asset rid>"
  ],
  "pinnedChecklistRefs": [
    {
      "rid": "<checklist rid>",
      "commit": "<commit id>"
    }
  ],
  "chartRids": [
    {
      "rid": "<viz id>",
      "version": 1
    }
  ],
  "notebookRids": [
    "<notebook rid>"
  ],
  "showArchived": true,
  "archivedStatuses": [
    "NOT_ARCHIVED"
  ]
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "nextPageToken": "<token>",
        "pageSize": 1,
        "sortBy": {"isDescending": True, "field": "CHECK_NAME"},
        "searchText": "<search text>",
        "after": {"seconds": 1, "nanos": 1},
        "before": {"seconds": 1, "nanos": 1},
        "status": ["PENDING_REVIEW"],
        "checkRids": ["<check rid>"],
        "dataReviewRids": ["<data review rid>"],
        "assigneeRids": ["<user rid>"],
        "priorities": ["P0"],
        "runRids": ["<run rid>"],
        "assetRids": ["<asset rid>"],
        "pinnedChecklistRefs": [{"rid": "<checklist rid>", "commit": "<commit id>"}],
        "chartRids": [{"rid": "<viz id>", "version": 1}],
        "notebookRids": ["<notebook rid>"],
        "showArchived": True,
        "archivedStatuses": ["NOT_ARCHIVED"],
    },
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "nextPageToken": "<token>",
        "pageSize": 1,
        "sortBy": {"isDescending": True, "field": "CHECK_NAME"},
        "searchText": "<search text>",
        "after": {"seconds": 1, "nanos": 1},
        "before": {"seconds": 1, "nanos": 1},
        "status": ["PENDING_REVIEW"],
        "checkRids": ["<check rid>"],
        "dataReviewRids": ["<data review rid>"],
        "assigneeRids": ["<user rid>"],
        "priorities": ["P0"],
        "runRids": ["<run rid>"],
        "assetRids": ["<asset rid>"],
        "pinnedChecklistRefs": [{"rid": "<checklist rid>", "commit": "<commit id>"}],
        "chartRids": [{"rid": "<viz id>", "version": 1}],
        "notebookRids": ["<notebook rid>"],
        "showArchived": True,
        "archivedStatuses": ["NOT_ARCHIVED"],
    },
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "nextPageToken": "<token>",
                "pageSize": 1,
                "sortBy": {"isDescending": True, "field": "CHECK_NAME"},
                "searchText": "<search text>",
                "after": {"seconds": 1, "nanos": 1},
                "before": {"seconds": 1, "nanos": 1},
                "status": ["PENDING_REVIEW"],
                "checkRids": ["<check rid>"],
                "dataReviewRids": ["<data review rid>"],
                "assigneeRids": ["<user rid>"],
                "priorities": ["P0"],
                "runRids": ["<run rid>"],
                "assetRids": ["<asset rid>"],
                "pinnedChecklistRefs": [
                    {"rid": "<checklist rid>", "commit": "<commit id>"},
                ],
                "chartRids": [{"rid": "<viz id>", "version": 1}],
                "notebookRids": ["<notebook rid>"],
                "showArchived": True,
                "archivedStatuses": ["NOT_ARCHIVED"],
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "nextPageToken": "<token>",
  "checkAlerts": [
    {
      "rid": "<check alert rid>",
      "checkRid": "<check rid>",
      "implementationIndex": 1,
      "dataReviewRid": "<data review rid>",
      "checkEvaluationRid": "<automatic check evaluation rid>",
      "name": "<name>",
      "autogeneratedCheckTitle": "<autogenerated check title>",
      "autogeneratedCheckDescription": "<autogenerated check description>",
      "assigneeRids": [
        "<user rid>"
      ],
      "start": {
        "seconds": 1,
        "nanos": 1
      },
      "end": {
        "seconds": 1,
        "nanos": 1
      },
      "state": {
        "type": "pendingReview",
        "pendingReview": {}
      },
      "priority": "P0",
      "chart": {
        "rid": "<viz id>",
        "version": 1
      },
      "notes": "<notes>",
      "notebook": "<notebook rid>"
    }
  ]
}

Get check alert action log#

GET /scout/v2/data-review/check-alerts/{checkAlertRid}/action-log

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns a record of the historical actions taken on the provided check alert.

Path parameters

checkAlertRid string (RID) required

​

Response

entries array of CheckAlertActionLogEntry

​

Fields of CheckAlertActionLogEntry
performedBy string (RID)

​

action CheckAlertAction

​

Set type to "closeWithIgnore".

closeWithIgnore CloseWithIgnoreAlert

​

Fields of CloseWithIgnoreAlert
comment string

​

strategy CloseStrategy

Defines the strategy for closing the alert and any alerts linked via an associated notebook. If not provided, the default strategy is closeAllLinkedAlerts.

Set type to "closeAllLinkedAlerts".

closeAllLinkedAlerts CloseAllLinkedAlerts

​

Set type to "closeAndDetachFromNotebook".

closeAndDetachFromNotebook CloseAndDetachFromNotebook

​

Set type to "closeAndDuplicatePreviouslyLinkedNotebook".

closeAndDuplicatePreviouslyLinkedNotebook CloseAndDuplicatePreviouslyLinkedNotebook

​

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Fields of CloseWithFurtherAction
comment string

​

strategy CloseStrategy

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.

Set type to "reopen".

reopen Reopen

​

Fields of Reopen
comment string

​

strategy ReopenStrategy

Defines the strategy for reopening the alert and any alerts linked via an associated notebook. If not provided, the default strategy is reopenAllLinkedAlerts.

Set type to "reopenAllLinkedAlerts".

reopenAllLinkedAlerts ReopenAllLinkedAlerts

​

Set type to "reopenAndDetachFromNotebook".

reopenAndDetachFromNotebook ReopenAndDetachFromNotebook

​

Set type to "reopenAndDuplicatePreviouslyLinkedNotebook".

reopenAndDuplicatePreviouslyLinkedNotebook ReopenAndDuplicatePreviouslyLinkedNotebook

​

Set type to "reassign".

reassign Reassign

​

Fields of Reassign
assigneeRids array of string (RID)

​

Set type to "updateNotes".

updateNotes UpdateNotes

​

Fields of UpdateNotes
notes string

​

Set type to "linkNotebook".

linkNotebook LinkNotebook

​

Fields of LinkNotebook
rid string (RID)

​

strategy LinkNotebookStrategy

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.

Set type to "duplicateAndLinkToNewNotebook".

duplicateAndLinkToNewNotebook DuplicateAndLinkNotebook

​

Set type to "closeAndLink".

closeAndLink CloseAndLinkToNotebook

​

Fields of CloseAndLinkToNotebook
closeAction CloseAction

​

Set type to "closeWithIgnore".

closeWithIgnore CloseWithIgnoreAlert

​

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Set type to "reopenAndLink".

reopenAndLink ReopenAndLinkToNotebook

​

Fields of ReopenAndLinkToNotebook
comment string

​

Set type to "unlinkNotebook".

unlinkNotebook UnlinkNotebook

​

Set type to "archiveDataReview".

archiveDataReview ArchiveDataReview

​

Set type to "unarchiveDataReview".

unarchiveDataReview UnarchiveDataReview

​

timestamp string (date-time)

​

Request

curl "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>/action-log" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>/action-log",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>/action-log",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.get(
            "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/<check alert rid>/action-log",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "entries": [
    {
      "performedBy": "<user rid>",
      "action": {
        "type": "closeWithIgnore",
        "closeWithIgnore": {
          "comment": "<comment>",
          "strategy": {
            "type": "closeAllLinkedAlerts",
            "closeAllLinkedAlerts": {}
          }
        }
      },
      "timestamp": "2026-01-01T00:00:00Z"
    }
  ]
}

Get check alert counts for notebooks#

POST /scout/v2/data-review/get-check-alert-counts-for-notebooks

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns the number of alerts attached to each provided notebook.

Body

The body is an array of string (RID).

Response

The body is a map of NotebookRid to integer.

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/get-check-alert-counts-for-notebooks" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '[
  "<notebook rid>"
]'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/get-check-alert-counts-for-notebooks",
    headers={"Authorization": "Bearer <api key>"},
    json=["<notebook rid>"],
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/get-check-alert-counts-for-notebooks",
    headers={"Authorization": "Bearer <api key>"},
    json=["<notebook rid>"],
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/get-check-alert-counts-for-notebooks",
            headers={"Authorization": "Bearer <api key>"},
            json=["<notebook rid>"],
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "<key>": 1
}

Get check alert status for notebooks#

POST /scout/v2/data-review/get-check-alert-status-for-notebooks

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns the check alert status of any linked violations for the provided notebooks. If none exist, an empty optional is returned.

Body

The body is an array of string (RID).

Response

The body is a map of NotebookRid to CheckAlertStatus.

Values of CheckAlertStatus
PENDING_REVIEW

​

CLOSED_IGNORED

​

CLOSED_REQUIRES_FURTHER_ACTION

​

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/get-check-alert-status-for-notebooks" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '[
  "<notebook rid>"
]'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/get-check-alert-status-for-notebooks",
    headers={"Authorization": "Bearer <api key>"},
    json=["<notebook rid>"],
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/get-check-alert-status-for-notebooks",
    headers={"Authorization": "Bearer <api key>"},
    json=["<notebook rid>"],
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/get-check-alert-status-for-notebooks",
            headers={"Authorization": "Bearer <api key>"},
            json=["<notebook rid>"],
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "<key>": "PENDING_REVIEW"
}

Batch perform check alert action#

POST /scout/v2/data-review/check-alerts/batch-perform-action

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

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.

Body

checkAlertAction CheckAlertAction required

​

Set type to "closeWithIgnore".

closeWithIgnore CloseWithIgnoreAlert

​

Fields of CloseWithIgnoreAlert
comment string required

​

strategy CloseStrategy

Defines the strategy for closing the alert and any alerts linked via an associated notebook. If not provided, the default strategy is closeAllLinkedAlerts.

Set type to "closeAllLinkedAlerts".

closeAllLinkedAlerts CloseAllLinkedAlerts

​

Set type to "closeAndDetachFromNotebook".

closeAndDetachFromNotebook CloseAndDetachFromNotebook

​

Set type to "closeAndDuplicatePreviouslyLinkedNotebook".

closeAndDuplicatePreviouslyLinkedNotebook CloseAndDuplicatePreviouslyLinkedNotebook

​

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Fields of CloseWithFurtherAction
comment string required

​

strategy CloseStrategy

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.

Set type to "reopen".

reopen Reopen

​

Fields of Reopen
comment string required

​

strategy ReopenStrategy

Defines the strategy for reopening the alert and any alerts linked via an associated notebook. If not provided, the default strategy is reopenAllLinkedAlerts.

Set type to "reopenAllLinkedAlerts".

reopenAllLinkedAlerts ReopenAllLinkedAlerts

​

Set type to "reopenAndDetachFromNotebook".

reopenAndDetachFromNotebook ReopenAndDetachFromNotebook

​

Set type to "reopenAndDuplicatePreviouslyLinkedNotebook".

reopenAndDuplicatePreviouslyLinkedNotebook ReopenAndDuplicatePreviouslyLinkedNotebook

​

Set type to "reassign".

reassign Reassign

​

Fields of Reassign
assigneeRids array of string (RID)

​

Set type to "updateNotes".

updateNotes UpdateNotes

​

Fields of UpdateNotes
notes string required

​

Set type to "linkNotebook".

linkNotebook LinkNotebook

​

Fields of LinkNotebook
rid string (RID) required

​

strategy LinkNotebookStrategy

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.

Set type to "duplicateAndLinkToNewNotebook".

duplicateAndLinkToNewNotebook DuplicateAndLinkNotebook

​

Set type to "closeAndLink".

closeAndLink CloseAndLinkToNotebook

​

Fields of CloseAndLinkToNotebook
closeAction CloseAction required

​

Set type to "closeWithIgnore".

closeWithIgnore CloseWithIgnoreAlert

​

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Set type to "reopenAndLink".

reopenAndLink ReopenAndLinkToNotebook

​

Fields of ReopenAndLinkToNotebook
comment string required

​

Set type to "unlinkNotebook".

unlinkNotebook UnlinkNotebook

​

Set type to "archiveDataReview".

archiveDataReview ArchiveDataReview

​

Set type to "unarchiveDataReview".

unarchiveDataReview UnarchiveDataReview

​

checkAlertRids array of string (RID)

​

Response

checkAlerts array of CheckAlert

​

Fields of CheckAlert
rid string (RID)

​

checkRid string (RID)

​

implementationIndex integer

​

dataReviewRid string (RID)

​

checkEvaluationRid string (RID)

​

name string

​

autogeneratedCheckTitle string

​

autogeneratedCheckDescription string

​

assigneeRids array of string (RID)

​

start Timestamp

​

Fields of Timestamp
seconds integer (int64)

​

nanos integer (int64)

​

end Timestamp

​

state CheckAlertState

​

Set type to "pendingReview".

pendingReview PendingReviewAlertState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

Fields of ClosedWithFurtherActionAlertState
comment string

​

closedBy string (RID)

​

Set type to "closedWithIgnore".

closedWithIgnore ClosedWithIgnoreAlertState

​

Fields of ClosedWithIgnoreAlertState
comment string

​

closedBy string (RID)

​

priority Priority

​

Values of Priority
P0

​

P1

​

P2

​

P3

​

P4

​

chart VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

Fields of VersionedVizId
rid string

​

version integer

​

notes string

​

notebook string (RID)

​

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/batch-perform-action" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "checkAlertAction": {
    "type": "closeWithIgnore",
    "closeWithIgnore": {
      "comment": "<comment>"
    }
  }
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/batch-perform-action",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "checkAlertAction": {
            "type": "closeWithIgnore",
            "closeWithIgnore": {"comment": "<comment>"},
        },
    },
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/batch-perform-action",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "checkAlertAction": {
            "type": "closeWithIgnore",
            "closeWithIgnore": {"comment": "<comment>"},
        },
    },
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/batch-perform-action",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "checkAlertAction": {
                    "type": "closeWithIgnore",
                    "closeWithIgnore": {"comment": "<comment>"},
                },
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "checkAlerts": [
    {
      "rid": "<check alert rid>",
      "checkRid": "<check rid>",
      "implementationIndex": 1,
      "dataReviewRid": "<data review rid>",
      "checkEvaluationRid": "<automatic check evaluation rid>",
      "name": "<name>",
      "autogeneratedCheckTitle": "<autogenerated check title>",
      "autogeneratedCheckDescription": "<autogenerated check description>",
      "assigneeRids": [
        "<user rid>"
      ],
      "start": {
        "seconds": 1,
        "nanos": 1
      },
      "end": {
        "seconds": 1,
        "nanos": 1
      },
      "state": {
        "type": "pendingReview",
        "pendingReview": {}
      },
      "priority": "P0",
      "chart": {
        "rid": "<viz id>",
        "version": 1
      },
      "notes": "<notes>",
      "notebook": "<notebook rid>"
    }
  ]
}

Batch perform automatic check evaluation review action#

POST /scout/v2/data-review/automatic-check-evaluation/batch-perform-action

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Applies an action to the specified check evaluation RIDs. If any of the check actions fail, then none of the actions will be applied.

Body

checkEvaluationAction AutomaticCheckEvaluationReviewAction required

​

Set type to "closeWithIgnore".

closeWithIgnore CloseWithIgnoreAlert

​

Fields of CloseWithIgnoreAlert
comment string required

​

strategy CloseStrategy

Defines the strategy for closing the alert and any alerts linked via an associated notebook. If not provided, the default strategy is closeAllLinkedAlerts.

Set type to "closeAllLinkedAlerts".

closeAllLinkedAlerts CloseAllLinkedAlerts

​

Set type to "closeAndDetachFromNotebook".

closeAndDetachFromNotebook CloseAndDetachFromNotebook

​

Set type to "closeAndDuplicatePreviouslyLinkedNotebook".

closeAndDuplicatePreviouslyLinkedNotebook CloseAndDuplicatePreviouslyLinkedNotebook

​

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Fields of CloseWithFurtherAction
comment string required

​

strategy CloseStrategy

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.

Set type to "reopen".

reopen Reopen

​

Fields of Reopen
comment string required

​

strategy ReopenStrategy

Defines the strategy for reopening the alert and any alerts linked via an associated notebook. If not provided, the default strategy is reopenAllLinkedAlerts.

Set type to "reopenAllLinkedAlerts".

reopenAllLinkedAlerts ReopenAllLinkedAlerts

​

Set type to "reopenAndDetachFromNotebook".

reopenAndDetachFromNotebook ReopenAndDetachFromNotebook

​

Set type to "reopenAndDuplicatePreviouslyLinkedNotebook".

reopenAndDuplicatePreviouslyLinkedNotebook ReopenAndDuplicatePreviouslyLinkedNotebook

​

Set type to "reassign".

reassign Reassign

​

Fields of Reassign
assigneeRids array of string (RID)

​

Set type to "updateNotes".

updateNotes UpdateNotes

​

Fields of UpdateNotes
notes string required

​

checkEvaluationRids array of string (RID)

​

Response

checkEvaluations array of AutomaticCheckEvaluation

​

Fields of AutomaticCheckEvaluation
rid string (RID)

​

checkRid string (RID)

​

checkImplementationIndex integer

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 string (RID)

​

state AutomaticCheckEvaluationState

​

Set type to "pendingExecution".

pendingExecution PendingExecutionState

​

Fields of PendingExecutionState
jobRid string (RID)

​

Set type to "failedToExecute".

failedToExecute FailedToExecuteState

​

Fields of FailedToExecuteState
jobRid string (RID)

​

reviewState CheckAlertState

​

Set type to "pendingReview".

pendingReview PendingReviewAlertState

​

Set type to "closedWithFurtherAction".

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

Fields of ClosedWithFurtherActionAlertState
comment string

​

closedBy string (RID)

​

Set type to "closedWithIgnore".

closedWithIgnore ClosedWithIgnoreAlertState

​

Fields of ClosedWithIgnoreAlertState
comment string

​

closedBy string (RID)

​

reviewNotes string

​

assigneeRids array of string (RID)

​

Set type to "passing".

passing PassingExecutionState

​

Set type to "generatedAlerts".

generatedAlerts GeneratedAlertsState

​

Fields of GeneratedAlertsState
rids array of string (RID) deprecated

Deprecated: This field is deprecated and will be removed in a future version. Use eventRids instead.

eventRids array of string (RID)

​

Set type to "tooManyAlerts".

tooManyAlerts TooManyAlertsState

​

Set type to "executing".

executing ExecutingState

​

Fields of ExecutingState
jobRid string (RID)

​

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/automatic-check-evaluation/batch-perform-action" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "checkEvaluationAction": {
    "type": "closeWithIgnore",
    "closeWithIgnore": {
      "comment": "<comment>"
    }
  }
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/automatic-check-evaluation/batch-perform-action",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "checkEvaluationAction": {
            "type": "closeWithIgnore",
            "closeWithIgnore": {"comment": "<comment>"},
        },
    },
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/automatic-check-evaluation/batch-perform-action",
    headers={"Authorization": "Bearer <api key>"},
    json={
        "checkEvaluationAction": {
            "type": "closeWithIgnore",
            "closeWithIgnore": {"comment": "<comment>"},
        },
    },
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/automatic-check-evaluation/batch-perform-action",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "checkEvaluationAction": {
                    "type": "closeWithIgnore",
                    "closeWithIgnore": {"comment": "<comment>"},
                },
            },
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "checkEvaluations": [
    {
      "rid": "<automatic check evaluation rid>",
      "checkRid": "<check rid>",
      "checkImplementationIndex": 1,
      "dataReviewRid": "<data review rid>",
      "state": {
        "type": "pendingExecution",
        "pendingExecution": {
          "jobRid": "<job rid>"
        }
      }
    }
  ]
}

Get automatic check evaluation action log#

GET /scout/v2/data-review/automatic-check-evaluation/{rid}/action-log

Deprecated: CheckAlerts have been replaced by Events. Please use the EventService instead.

Path parameters

rid string (RID) required

​

Response

entries array of AutomaticCheckEvaluationActionLogEntry

​

Fields of AutomaticCheckEvaluationActionLogEntry
action AutomaticCheckEvaluationAction

​

Set type to "executionFinished".

executionFinished AutomaticCheckExecutionFinished

​

Fields of AutomaticCheckExecutionFinished
jobRid string (RID)

​

status Status

​

Values of Status
PASS

​

FAIL

​

Set type to "executionFailedToRun".

executionFailedToRun AutomaticCheckExecutionFailedToRun

​

Fields of AutomaticCheckExecutionFailedToRun
jobRid string (RID)

​

Set type to "executionRetriggered".

executionRetriggered ExecutionRetriggered

​

Fields of ExecutionRetriggered
jobRid string (RID)

​

Set type to "executionStarted".

executionStarted AutomaticCheckExecutionStarted

​

Fields of AutomaticCheckExecutionStarted
jobRid string (RID)

​

timestamp string (date-time)

​

Request

curl "https://api.gov.nominal.io/api/scout/v2/data-review/automatic-check-evaluation/<rid>/action-log" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/automatic-check-evaluation/<rid>/action-log",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/automatic-check-evaluation/<rid>/action-log",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.get(
            "https://api.gov.nominal.io/api/scout/v2/data-review/automatic-check-evaluation/<rid>/action-log",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "entries": [
    {
      "action": {
        "type": "executionFinished",
        "executionFinished": {
          "jobRid": "<job rid>",
          "status": "PASS"
        }
      },
      "timestamp": "2026-01-01T00:00:00Z"
    }
  ]
}

Batch perform manual check alert action#

POST /scout/v2/data-review/manual-check-evaluation/batch-perform-action

Deprecated: No longer in use

Applies an action to the specified check evaluation RIDs. If any of the check actions fail, then none of the actions will be applied.

Body

checkAlertAction ManualCheckAlertAction required

​

Set type to "pass".

pass Pass

​

Fields of Pass
comment string required

​

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Fields of CloseWithFurtherAction
comment string required

​

strategy CloseStrategy

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.

Set type to "closeAllLinkedAlerts".

closeAllLinkedAlerts CloseAllLinkedAlerts

​

Set type to "closeAndDetachFromNotebook".

closeAndDetachFromNotebook CloseAndDetachFromNotebook

​

Set type to "closeAndDuplicatePreviouslyLinkedNotebook".

closeAndDuplicatePreviouslyLinkedNotebook CloseAndDuplicatePreviouslyLinkedNotebook

​

Set type to "reopen".

reopen Reopen

​

Fields of Reopen
comment string required

​

strategy ReopenStrategy

Defines the strategy for reopening the alert and any alerts linked via an associated notebook. If not provided, the default strategy is reopenAllLinkedAlerts.

Set type to "reopenAllLinkedAlerts".

reopenAllLinkedAlerts ReopenAllLinkedAlerts

​

Set type to "reopenAndDetachFromNotebook".

reopenAndDetachFromNotebook ReopenAndDetachFromNotebook

​

Set type to "reopenAndDuplicatePreviouslyLinkedNotebook".

reopenAndDuplicatePreviouslyLinkedNotebook ReopenAndDuplicatePreviouslyLinkedNotebook

​

Set type to "reassign".

reassign Reassign

​

Fields of Reassign
assigneeRids array of string (RID)

​

Set type to "updateNotes".

updateNotes UpdateNotes

​

Fields of UpdateNotes
notes string required

​

Set type to "linkNotebook".

linkNotebook LinkNotebook

​

Fields of LinkNotebook
rid string (RID) required

​

strategy LinkNotebookStrategy

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.

Set type to "duplicateAndLinkToNewNotebook".

duplicateAndLinkToNewNotebook DuplicateAndLinkNotebook

​

Set type to "closeAndLink".

closeAndLink CloseAndLinkToNotebook

​

Fields of CloseAndLinkToNotebook
closeAction CloseAction required

​

Set type to "closeWithIgnore".

closeWithIgnore CloseWithIgnoreAlert

​

Fields of CloseWithIgnoreAlert
comment string required

​

strategy CloseStrategy

Defines the strategy for closing the alert and any alerts linked via an associated notebook. If not provided, the default strategy is closeAllLinkedAlerts.

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Set type to "reopenAndLink".

reopenAndLink ReopenAndLinkToNotebook

​

Fields of ReopenAndLinkToNotebook
comment string required

​

checkEvaluationRids array of string (RID)

​

Response

No content (HTTP 204).

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/manual-check-evaluation/batch-perform-action" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "checkAlertAction": {
    "type": "pass",
    "pass": {
      "comment": "<comment>"
    }
  }
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/manual-check-evaluation/batch-perform-action",
    headers={"Authorization": "Bearer <api key>"},
    json={"checkAlertAction": {"type": "pass", "pass": {"comment": "<comment>"}}},
)
response.raise_for_status()

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/manual-check-evaluation/batch-perform-action",
    headers={"Authorization": "Bearer <api key>"},
    json={"checkAlertAction": {"type": "pass", "pass": {"comment": "<comment>"}}},
)
response.raise_for_status()

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/manual-check-evaluation/batch-perform-action",
            headers={"Authorization": "Bearer <api key>"},
            json={
                "checkAlertAction": {"type": "pass", "pass": {"comment": "<comment>"}},
            },
        ) as response:
            response.raise_for_status()


asyncio.run(main())

Response: 204

No content.

Get manual check evaluation action log#

GET /scout/v2/data-review/manual-check-evaluation/{rid}/action-log

Deprecated: No longer in use

Returns a record of the historical manual actions taken on the provided check evaluation.

Path parameters

rid string (RID) required

​

Response

entries array of ManualCheckEvaluationActionLogEntry

​

Fields of ManualCheckEvaluationActionLogEntry
performedBy string (RID)

​

action ManualCheckAlertAction

​

Set type to "pass".

pass Pass

​

Fields of Pass
comment string

​

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Fields of CloseWithFurtherAction
comment string

​

strategy CloseStrategy

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.

Set type to "closeAllLinkedAlerts".

closeAllLinkedAlerts CloseAllLinkedAlerts

​

Set type to "closeAndDetachFromNotebook".

closeAndDetachFromNotebook CloseAndDetachFromNotebook

​

Set type to "closeAndDuplicatePreviouslyLinkedNotebook".

closeAndDuplicatePreviouslyLinkedNotebook CloseAndDuplicatePreviouslyLinkedNotebook

​

Set type to "reopen".

reopen Reopen

​

Fields of Reopen
comment string

​

strategy ReopenStrategy

Defines the strategy for reopening the alert and any alerts linked via an associated notebook. If not provided, the default strategy is reopenAllLinkedAlerts.

Set type to "reopenAllLinkedAlerts".

reopenAllLinkedAlerts ReopenAllLinkedAlerts

​

Set type to "reopenAndDetachFromNotebook".

reopenAndDetachFromNotebook ReopenAndDetachFromNotebook

​

Set type to "reopenAndDuplicatePreviouslyLinkedNotebook".

reopenAndDuplicatePreviouslyLinkedNotebook ReopenAndDuplicatePreviouslyLinkedNotebook

​

Set type to "reassign".

reassign Reassign

​

Fields of Reassign
assigneeRids array of string (RID)

​

Set type to "updateNotes".

updateNotes UpdateNotes

​

Fields of UpdateNotes
notes string

​

Set type to "linkNotebook".

linkNotebook LinkNotebook

​

Fields of LinkNotebook
rid string (RID)

​

strategy LinkNotebookStrategy

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.

Set type to "duplicateAndLinkToNewNotebook".

duplicateAndLinkToNewNotebook DuplicateAndLinkNotebook

​

Set type to "closeAndLink".

closeAndLink CloseAndLinkToNotebook

​

Fields of CloseAndLinkToNotebook
closeAction CloseAction

​

Set type to "closeWithIgnore".

closeWithIgnore CloseWithIgnoreAlert

​

Fields of CloseWithIgnoreAlert
comment string

​

strategy CloseStrategy

Defines the strategy for closing the alert and any alerts linked via an associated notebook. If not provided, the default strategy is closeAllLinkedAlerts.

Set type to "closeWithFurtherAction".

closeWithFurtherAction CloseWithFurtherAction

​

Set type to "reopenAndLink".

reopenAndLink ReopenAndLinkToNotebook

​

Fields of ReopenAndLinkToNotebook
comment string

​

timestamp string (date-time)

​

Request

curl "https://api.gov.nominal.io/api/scout/v2/data-review/manual-check-evaluation/<rid>/action-log" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/manual-check-evaluation/<rid>/action-log",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.get(
    "https://api.gov.nominal.io/api/scout/v2/data-review/manual-check-evaluation/<rid>/action-log",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.get(
            "https://api.gov.nominal.io/api/scout/v2/data-review/manual-check-evaluation/<rid>/action-log",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "entries": [
    {
      "performedBy": "<user rid>",
      "action": {
        "type": "pass",
        "pass": {
          "comment": "<comment>"
        }
      },
      "timestamp": "2026-01-01T00:00:00Z"
    }
  ]
}

Archive data review#

POST /scout/v2/data-review/{dataReviewRid}/archive

Archives the data review with the given rid.

Path parameters

dataReviewRid string (RID) required

​

Response

The body is a boolean.

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>/archive" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>/archive",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>/archive",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/<data review rid>/archive",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

true

Batch archive data review#

POST /scout/v2/data-review/batch-archive

Batch archives the data reviews with the given rids.

Body

The body is an array of string (RID).

Response

No content (HTTP 204).

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/batch-archive" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '[
  "<data review rid>"
]'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/batch-archive",
    headers={"Authorization": "Bearer <api key>"},
    json=["<data review rid>"],
)
response.raise_for_status()

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/batch-archive",
    headers={"Authorization": "Bearer <api key>"},
    json=["<data review rid>"],
)
response.raise_for_status()

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/batch-archive",
            headers={"Authorization": "Bearer <api key>"},
            json=["<data review rid>"],
        ) as response:
            response.raise_for_status()


asyncio.run(main())

Response: 204

No content.

Unarchive data review#

POST /scout/v2/data-review/unarchive/{dataReviewRid}

Unarchives the data review with the given rid.

Path parameters

dataReviewRid string (RID) required

​

Response

No content (HTTP 204).

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/unarchive/<data review rid>" \
  -H "Authorization: Bearer <api key>"

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/unarchive/<data review rid>",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/unarchive/<data review rid>",
    headers={"Authorization": "Bearer <api key>"},
)
response.raise_for_status()

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/unarchive/<data review rid>",
            headers={"Authorization": "Bearer <api key>"},
        ) as response:
            response.raise_for_status()


asyncio.run(main())

Response: 204

No content.

Get data review check metrics#

POST /scout/v2/data-review/data-review-check-metrics

Body

scope DataReviewCheckMetricsScope required

​

Set type to "runRid".

runRid string (RID)

​

Set type to "assetRid".

assetRid string (RID)

​

Set type to "dataReviewRid".

dataReviewRid string (RID)

​

Response

checksPendingExecution integer

​

checksExecuting integer

​

checksPassed integer

​

checksWithEventsPendingReview integer

​

checksWithEventsClosedWithIgnore integer

​

checksWithEventsClosedWithFurtherAction integer

​

checksWithEvents integer

​

checksWithTooManyEvents integer

​

checksFailedToExecutePendingReview integer

​

checksFailedToExecuteClosedWithIgnore integer

​

checksFailedToExecuteClosedWithFurtherAction integer

​

checksFailedToExecute integer

​

checksExecuted integer

​

checksTotal integer

​

eventsPendingReview integer

​

eventsClosedWithIgnore integer

​

eventsClosedWithFurtherAction integer

​

eventsTotal integer

​

Request

curl -X POST "https://api.gov.nominal.io/api/scout/v2/data-review/data-review-check-metrics" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "scope": {
    "type": "runRid",
    "runRid": "<run rid>"
  }
}'

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/data-review-check-metrics",
    headers={"Authorization": "Bearer <api key>"},
    json={"scope": {"type": "runRid", "runRid": "<run rid>"}},
)
response.raise_for_status()
print(response.json())

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/scout/v2/data-review/data-review-check-metrics",
    headers={"Authorization": "Bearer <api key>"},
    json={"scope": {"type": "runRid", "runRid": "<run rid>"}},
)
response.raise_for_status()
print(response.json())

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/scout/v2/data-review/data-review-check-metrics",
            headers={"Authorization": "Bearer <api key>"},
            json={"scope": {"type": "runRid", "runRid": "<run rid>"}},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{
  "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
}

Errors#

Errors shows how these errors are sent.

Each error’s errorName is DataReview: followed by its name below.

Status

Name

Notes

400

AutomaticCheckEvaluationNotFound

400

AutomaticCheckEvaluationsNotFound

400

CannotPerformCheckAlertAction

400

CheckAlertNotFound

400

FailedToResolveSeriesForCheck

400

InvalidPageToken

400

ManualCheckEvaluationNotFound

400

ManualCheckEvaluationsNotFound

400

NoPointsInRange

400

ReviewCommentIsEmpty

404

CheckAlertsNotFound

404

DataReviewNotFound

404

DataReviewsNotFound

404

LinkedDataReviewsNotFound

404

LinkedNotebooksNotFound

404

NotebooksNotFound

500

FailedToPerformAutomaticCheckEvaluationReviewAction

500

FailedToPerformCheckAlertAction

Each error’s errorName is Checks: followed by its name below.

Status

Name

Notes

404

AssetsNotFound

404

ChecklistsNotFound

404

RunsNotFound

Types#

ArchiveDataReview#

Archive the data review which created this check alert. Only performable via the archive data review endpoint; not supported by Perform Check Alert Action.

An empty JSON object, {}.

ArchivedStatus#

NOT_ARCHIVED

​

ARCHIVED

​

AutomaticCheckEvaluation#

rid string (RID) required

​

checkRid string (RID) required

​

checkImplementationIndex integer

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 string (RID) required

​

state AutomaticCheckEvaluationState required

​

AutomaticCheckEvaluationAction#

Set type to the name of one of the other fields, and set only that field.

executionFinished AutomaticCheckExecutionFinished

​

executionFailedToRun AutomaticCheckExecutionFailedToRun

​

executionRetriggered ExecutionRetriggered

​

executionStarted AutomaticCheckExecutionStarted

​

AutomaticCheckEvaluationActionLogEntry#

action AutomaticCheckEvaluationAction required

​

timestamp string (date-time) required

​

AutomaticCheckEvaluationReviewAction#

Set type to the name of one of the other fields, and set only that field.

closeWithIgnore CloseWithIgnoreAlert

​

closeWithFurtherAction CloseWithFurtherAction

​

reopen Reopen

​

reassign Reassign

​

updateNotes UpdateNotes

​

AutomaticCheckEvaluationState#

Set type to the name of one of the other fields, and set only that field.

pendingExecution PendingExecutionState

​

failedToExecute FailedToExecuteState

​

passing PassingExecutionState

​

generatedAlerts GeneratedAlertsState

​

tooManyAlerts TooManyAlertsState

​

executing ExecutingState

​

AutomaticCheckExecutionFailedToRun#

jobRid string (RID) required

​

AutomaticCheckExecutionFinished#

jobRid string (RID) required

​

status Status required

​

AutomaticCheckExecutionStarted#

jobRid string (RID) required

​

CheckAlert#

rid string (RID) required

​

checkRid string (RID) required

​

implementationIndex integer

​

dataReviewRid string (RID) required

​

checkEvaluationRid string (RID) required

​

name string required

​

autogeneratedCheckTitle string

​

autogeneratedCheckDescription string

​

assigneeRids array of string (RID)

​

start Timestamp required

​

end Timestamp

​

state CheckAlertState required

​

priority Priority required

​

chart VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

notes string

​

notebook string (RID)

​

CheckAlertAction#

Set type to the name of one of the other fields, and set only that field.

closeWithIgnore CloseWithIgnoreAlert

​

closeWithFurtherAction CloseWithFurtherAction

​

reopen Reopen

​

reassign Reassign

​

updateNotes UpdateNotes

​

linkNotebook LinkNotebook

​

unlinkNotebook UnlinkNotebook

​

archiveDataReview ArchiveDataReview

​

unarchiveDataReview UnarchiveDataReview

​

CheckAlertActionLogEntry#

performedBy string (RID) required

​

action CheckAlertAction required

​

timestamp string (date-time) required

​

CheckAlertsHistogramBuckets#

Set type to the name of one of the other fields, and set only that field.

unstacked CheckAlertsUnstackedHistogram

​

priority CheckAlertsPriorityHistogram

​

status CheckAlertsStatusHistogram

​

CheckAlertsPriorityHistogram#

buckets array of HistogramPriorityBucket

​

CheckAlertsStatusHistogram#

buckets array of HistogramStatusBucket

​

CheckAlertState#

Set type to the name of one of the other fields, and set only that field.

pendingReview PendingReviewAlertState

​

closedWithFurtherAction ClosedWithFurtherActionAlertState

​

closedWithIgnore ClosedWithIgnoreAlertState

​

CheckAlertStatus#

PENDING_REVIEW

​

CLOSED_IGNORED

​

CLOSED_REQUIRES_FURTHER_ACTION

​

CheckAlertsUnstackedHistogram#

buckets array of HistogramBucket

​

CheckEvaluation#

Set type to the name of one of the other fields, and set only that field.

automaticCheck AutomaticCheckEvaluation

​

manualCheck ManualCheckEvaluation

​

ChecklistEvaluation#

checklist PinnedChecklistRef required

​

dataReviewRid string (RID) required

​

checks array of CheckEvaluation

​

ChecklistRef#

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”.

rid string (RID) required

​

commit string

​

CloseAction#

Set type to the name of one of the other fields, and set only that field.

closeWithIgnore CloseWithIgnoreAlert

​

closeWithFurtherAction CloseWithFurtherAction

​

CloseAllLinkedAlerts#

Close all alerts associated with the same notebook with the same comment.

An empty JSON object, {}.

CloseAndDetachFromNotebook#

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.

An empty JSON object, {}.

CloseAndDuplicatePreviouslyLinkedNotebook#

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.

An empty JSON object, {}.

CloseAndLinkToNotebook#

Close the alert and link to notebook. Throws if the associated notebook has open alerts.

closeAction CloseAction required

​

ClosedWithFurtherActionAlertState#

comment string required

​

closedBy string (RID) required

​

ClosedWithFurtherActionState#

comment string required

​

closedBy string (RID) required

​

ClosedWithIgnoreAlertState#

comment string required

​

closedBy string (RID) required

​

CloseStrategy#

Set type to the name of one of the other fields, and set only that field.

closeAllLinkedAlerts CloseAllLinkedAlerts

​

closeAndDetachFromNotebook CloseAndDetachFromNotebook

​

closeAndDuplicatePreviouslyLinkedNotebook CloseAndDuplicatePreviouslyLinkedNotebook

​

CloseWithFurtherAction#

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.

comment string required

​

strategy CloseStrategy

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.

CloseWithIgnoreAlert#

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.

comment string required

​

strategy CloseStrategy

Defines the strategy for closing the alert and any alerts linked via an associated notebook. If not provided, the default strategy is closeAllLinkedAlerts.

CreateDataReviewRequest#

If commit not is provided, the latest commit on main will be used. Asset RID is required only for multi-asset runs.

runRid string (RID) required

​

assetRid string (RID)

Selects asset to execute data review on. Required for multi-asset runs.

checklistRid string (RID) required

​

commit string

​

DataReview#

rid string (RID) required

​

runRid string (RID) required

​

assetRid string (RID) required

​

createdAt string (date-time) required

​

createdBy string (RID) required

​

checklist ChecklistEvaluation deprecated

Deprecated: This field is deprecated and will be removed in a future version.

checklistRef PinnedChecklistRef required

​

checkEvaluations array of AutomaticCheckEvaluation

​

archived boolean required

​

DataReviewCheckMetricsScope#

Set type to the name of one of the other fields, and set only that field.

runRid string (RID)

​

assetRid string (RID)

​

dataReviewRid string (RID)

​

DuplicateAndLinkNotebook#

Duplicate the notebook and link the alert to it.

An empty JSON object, {}.

ExecutingState#

jobRid string (RID) required

​

ExecutionRetriggered#

jobRid string (RID) required

​

FailedToExecuteState#

jobRid string (RID) required

​

reviewState CheckAlertState

​

reviewNotes string

​

assigneeRids array of string (RID)

​

GeneratedAlertsState#

rids array of string (RID) deprecated

Deprecated: This field is deprecated and will be removed in a future version. Use eventRids instead.

eventRids array of string (RID)

​

HistogramBucket#

startInclusive Timestamp required

​

endExclusive Timestamp required

​

count integer required

​

HistogramDistributionVariable#

Set type to the name of one of the other fields, and set only that field.

startTime HistogramStartTimeVariable

​

HistogramPriorityBucket#

startInclusive Timestamp required

​

endExclusive Timestamp required

​

counts map of string to integer

​

HistogramPriorityVariable#

An empty JSON object, {}.

HistogramStartTimeVariable#

An empty JSON object, {}.

HistogramStatusBucket#

startInclusive Timestamp required

​

endExclusive Timestamp required

​

counts map of string to integer

​

HistogramStatusVariable#

An empty JSON object, {}.

HistogramSubGroupVariable#

Set type to the name of one of the other fields, and set only that field.

priority HistogramPriorityVariable

​

status HistogramStatusVariable

​

LinkNotebook#

rid string (RID) required

​

strategy LinkNotebookStrategy

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.

LinkNotebookStrategy#

Set type to the name of one of the other fields, and set only that field.

duplicateAndLinkToNewNotebook DuplicateAndLinkNotebook

​

closeAndLink CloseAndLinkToNotebook

​

reopenAndLink ReopenAndLinkToNotebook

​

ManualCheckAlertAction#

Set type to the name of one of the other fields, and set only that field.

pass Pass

​

closeWithFurtherAction CloseWithFurtherAction

​

reopen Reopen

​

reassign Reassign

​

updateNotes UpdateNotes

​

linkNotebook LinkNotebook

​

ManualCheckEvaluation#

rid string (RID) required

​

checkRid string (RID) required

​

dataReviewRid string (RID) required

​

state ManualCheckEvaluationState required

​

assigneeRids array of string (RID)

​

chart VersionedVizId deprecated

Deprecated: charts are no longer versioned resources.

notes string

​

notebook string (RID)

​

ManualCheckEvaluationActionLogEntry#

performedBy string (RID) required

​

action ManualCheckAlertAction required

​

timestamp string (date-time) required

​

ManualCheckEvaluationState#

Set type to the name of one of the other fields, and set only that field.

pendingReview PendingReviewState

​

closedWithFurtherAction ClosedWithFurtherActionState

​

passing PassState

​

NotificationConfiguration#

Configuration details to send notifications to a linked integration.

integrationRid string (RID) required

​

notificationFilters array of NotificationFilter

Specifies the type of notifications to filter. If not provided, all notifications are sent.

appendedWorkbookRid string (RID)

If provided, appends a link to the workbook specified by the RID to the notification.

tags array of string

20 tags max, 50 characters max each. Tags are used to filter messages in Opsgenie. For other integrations, tags are ignored.

muteUntil string (date-time)

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.

NotificationFilter#

Specifies a type of notification to filter.

EXECUTION_ERROR

​

Pass#

comment string required

​

PassingExecutionState#

An empty JSON object, {}.

PassState#

comment string required

​

closedBy string (RID) required

​

PendingExecutionState#

jobRid string (RID) required

​

PendingReviewAlertState#

An empty JSON object, {}.

PendingReviewState#

An empty JSON object, {}.

PinnedChecklistRef#

A reference to a checklist that is pinned to a specific commit.

rid string (RID) required

​

commit string required

​

Priority#

P0

​

P1

​

P2

​

P3

​

P4

​

Reassign#

assigneeRids array of string (RID)

​

Reopen#

comment string required

​

strategy ReopenStrategy

Defines the strategy for reopening the alert and any alerts linked via an associated notebook. If not provided, the default strategy is reopenAllLinkedAlerts.

ReopenAllLinkedAlerts#

Reopen all alerts associated with the same notebook and unlock the notebook.

An empty JSON object, {}.

ReopenAndDetachFromNotebook#

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.

An empty JSON object, {}.

ReopenAndDuplicatePreviouslyLinkedNotebook#

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.

An empty JSON object, {}.

ReopenAndLinkToNotebook#

Reopen the alert and link to notebook. Throws if the associated notebook has closed alerts.

comment string required

​

ReopenStrategy#

Set type to the name of one of the other fields, and set only that field.

reopenAllLinkedAlerts ReopenAllLinkedAlerts

​

reopenAndDetachFromNotebook ReopenAndDetachFromNotebook

​

reopenAndDuplicatePreviouslyLinkedNotebook ReopenAndDuplicatePreviouslyLinkedNotebook

​

SearchCheckAlertsSortField#

CHECK_NAME

​

START

​

END

​

STATUS

​

PRIORITY

​

DURATION

​

SearchCheckAlertsSortOptions#

isDescending boolean required

​

field SearchCheckAlertsSortField required

​

Status#

PASS

​

FAIL

​

Timestamp#

Deprecated for new APIs. Use google.protobuf.Timestamp for absolute instants in proto APIs.

This 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.

seconds integer (int64) required

​

nanos integer (int64) required

​

TooManyAlertsState#

The number of generated alerts is greater than the maximum. The check is likely misconfigured.

An empty JSON object, {}.

UnarchiveDataReview#

Unarchive the data review which created this check alert. Only performable via the unarchive data review endpoint; not supported by Perform Check Alert Action.

An empty JSON object, {}.

UnlinkNotebook#

An empty JSON object, {}.

UpdateNotes#

notes string required

​

VersionedVizId#

rid string required

​

version integer required

​

Page design based on Scalar, MIT License.