Get Check Alerts Histogram

POST

Returns a histogram of alerts that occur across the provided runs.

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: PENDING_REVIEWCLOSED_IGNOREDCLOSED_REQUIRES_FURTHER_ACTION

checkRidsset of stringsOptional

dataReviewRidsset of stringsOptional

assigneeRidsset of stringsOptional

prioritiesset of enumsOptional

Allowed values: P0P1P2P3P4

pinnedChecklistRefsset of objectsOptional

chartRidsset of objectsOptional

notebookRidsset of stringsOptional

showArchivedbooleanOptionalDefaults to false

If not present, will not show archived data reviews in search results

Response

This endpoint returns an object.

bucketsobject

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/histogram \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "distributionVariable": {
6     "type": "startTime",
7     "startTime": {}
8   },
9   "startTimeAfter": {
10     "seconds": 1000000,
11     "nanos": 1000000
12   },
13   "startTimeBefore": {
14     "seconds": 1000000,
15     "nanos": 1000000
16   },
17   "runRids": [
18     "runRids"
19   ],
20   "assetRids": [
21     "assetRids"
22   ]
23 }'

200Successful

1 {
2   "buckets": {
3     "type": "unstacked",
4     "unstacked": {
5       "buckets": [
6         {
7           "startInclusive": {
8             "seconds": 1000000,
9             "nanos": 1000000,
10             "picos": 1
11           },
12           "endExclusive": {
13             "seconds": 1000000,
14             "nanos": 1000000,
15             "picos": 1
16           },
17           "count": 1
18         },
19         {
20           "startInclusive": {
21             "seconds": 1000000,
22             "nanos": 1000000,
23             "picos": 1
24           },
25           "endExclusive": {
26             "seconds": 1000000,
27             "nanos": 1000000,
28             "picos": 1
29           },
30           "count": 1
31         }
32       ]
33     }
34   }
35 }

Search Check Alerts

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v2/data-review/check-alerts/histogram \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"distributionVariable": {
6	"type": "startTime",
7	"startTime": {}
8	},
9	"startTimeAfter": {
10	"seconds": 1000000,
11	"nanos": 1000000
12	},
13	"startTimeBefore": {
14	"seconds": 1000000,
15	"nanos": 1000000
16	},
17	"runRids": [
18	"runRids"
19	],
20	"assetRids": [
21	"assetRids"
22	]
23	}'

1	{
2	"buckets": {
3	"type": "unstacked",
4	"unstacked": {
5	"buckets": [
6	{
7	"startInclusive": {
8	"seconds": 1000000,
9	"nanos": 1000000,
10	"picos": 1
11	},
12	"endExclusive": {
13	"seconds": 1000000,
14	"nanos": 1000000,
15	"picos": 1
16	},
17	"count": 1
18	},
19	{
20	"startInclusive": {
21	"seconds": 1000000,
22	"nanos": 1000000,
23	"picos": 1
24	},
25	"endExclusive": {
26	"seconds": 1000000,
27	"nanos": 1000000,
28	"picos": 1
29	},
30	"count": 1
31	}
32	]
33	}
34	}
35	}