API ReferenceData Review

Get Check Alerts Histogram

Returns a histogram of alerts that occur across the provided runs or assets. 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.
distributionVariableobjectRequired

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

startTimeAfterobjectRequired

Filters to start times after this time, inclusive.

startTimeBeforeobjectRequired

Filters to start times before this time, exclusive.

runRidsset of stringsRequired
assetRidsset of stringsRequired
numBinsintegerOptional

Defaults to 100. Throws if larger than 1_000.

searchTextstringOptional

Matches on check name

subGroupVariableobjectOptional

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

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 not present, 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.
bucketsobject