API ReferenceData Review

Search Check Alerts

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

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
runRidsset of stringsRequired
assetRidsset of stringsRequired
nextPageTokenstringOptional

Tokens are used with paginated requests to get the next “page” of results from an API, and typically are used as both part of the request and response schema of an endpoint to allow users to stream pages of results.

pageSizeintegerOptional

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

sortByobjectOptional

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

searchTextstringOptional

Matches on check name

afterobjectOptional

Filters to start times after this time, inclusive.

beforeobjectOptional

Filters to start times before this time, exclusive.

statusset of enumsOptional
Allowed values:
checkRidsset of stringsOptional
dataReviewRidsset of stringsOptional
assigneeRidsset of stringsOptional
prioritiesset of enumsOptional
Allowed values:
pinnedChecklistRefsset of objectsOptional
chartRidsset of objectsOptional
notebookRidsset of stringsOptional
showArchivedbooleanOptional

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

archivedStatusesset of enumsOptional

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

Allowed values:

Response

This endpoint returns an object.
checkAlertslist of objects
nextPageTokenstringOptional

Tokens are used with paginated requests to get the next “page” of results from an API, and typically are used as both part of the request and response schema of an endpoint to allow users to stream pages of results.