API ReferenceRun

Search Runs With Data Review Metrics

Searches for runs that match the given filters and includes metrics for check and violation review status.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
sortobjectRequired
pageSizeintegerRequired

Will reject page sizes greater than 10k.

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

archivedStatusesset of enumsOptional

Default search status is NOT_ARCHIVED if none are provided. Allows for including archived runs in search.

Allowed values:

Response

This endpoint returns an object.
resultslist 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.