Get Run With Data Review Metrics

GET

Fetches details about the run in question based on its RID, including metrics for check and violation review status.

Path parameters

ridstringRequired

Response

This endpoint returns an object.

runobject

dataReviewMetricsobject

GET

1 curl https://api.gov.nominal.io/api/scout/v1/run/rid/with-data-review-metrics \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "run": {
3     "rid": "rid",
4     "runNumber": 1000000,
5     "title": "title",
6     "description": "description",
7     "startTime": {
8       "secondsSinceEpoch": 1000000,
9       "offsetNanoseconds": 1000000
10     },
11     "properties": {
12       "properties": "properties"
13     },
14     "labels": [
15       "labels"
16     ],
17     "links": [
18       {
19         "url": "url",
20         "title": "title"
21       },
22       {
23         "url": "url",
24         "title": "title"
25       }
26     ],
27     "createdAt": "2024-01-15T09:30:00Z",
28     "updatedAt": "2024-01-15T09:30:00Z",
29     "dataSources": {
30       "dataSources": {
31         "dataSource": {
32           "type": "dataset",
33           "dataset": "dataSource"
34         },
35         "offset": {
36           "seconds": 1000000,
37           "nanos": 1000000,
38           "picos": 1
39         },
40         "refName": "refName",
41         "timestampType": "ABSOLUTE",
42         "seriesTags": {
43           "seriesTags": "seriesTags"
44         }
45       }
46     },
47     "attachments": [
48       "attachments"
49     ],
50     "assets": [
51       "assets",
52       "assets"
53     ],
54     "runPrefix": "runPrefix",
55     "authorRid": "authorRid",
56     "endTime": {
57       "secondsSinceEpoch": 1000000,
58       "offsetNanoseconds": 1000000
59     },
60     "asset": "asset"
61   },
62   "dataReviewMetrics": {
63     "checks": {
64       "pendingExecution": 1,
65       "executing": 1,
66       "passingAutomatic": 1,
67       "pendingReview": 1,
68       "closedWithIgnore": 1,
69       "closedWithFurtherAction": 1,
70       "failedToExecutePendingReview": 1,
71       "failedToExecuteClosedWithIgnore": 1,
72       "failedToExecuteClosedWithFurtherAction": 1
73     },
74     "alerts": {
75       "pendingReview": 1,
76       "closedWithIgnore": 1,
77       "closedWithFurtherAction": 1
78     }
79   }
80 }

Get Run With Data Review Summary

Up Next

Built with

1	curl https://api.gov.nominal.io/api/scout/v1/run/rid/with-data-review-metrics \
2	-H "Authorization: Bearer <token>"

1	{
2	"run": {
3	"rid": "rid",
4	"runNumber": 1000000,
5	"title": "title",
6	"description": "description",
7	"startTime": {
8	"secondsSinceEpoch": 1000000,
9	"offsetNanoseconds": 1000000
10	},
11	"properties": {
12	"properties": "properties"
13	},
14	"labels": [
15	"labels"
16	],
17	"links": [
18	{
19	"url": "url",
20	"title": "title"
21	},
22	{
23	"url": "url",
24	"title": "title"
25	}
26	],
27	"createdAt": "2024-01-15T09:30:00Z",
28	"updatedAt": "2024-01-15T09:30:00Z",
29	"dataSources": {
30	"dataSources": {
31	"dataSource": {
32	"type": "dataset",
33	"dataset": "dataSource"
34	},
35	"offset": {
36	"seconds": 1000000,
37	"nanos": 1000000,
38	"picos": 1
39	},
40	"refName": "refName",
41	"timestampType": "ABSOLUTE",
42	"seriesTags": {
43	"seriesTags": "seriesTags"
44	}
45	}
46	},
47	"attachments": [
48	"attachments"
49	],
50	"assets": [
51	"assets",
52	"assets"
53	],
54	"runPrefix": "runPrefix",
55	"authorRid": "authorRid",
56	"endTime": {
57	"secondsSinceEpoch": 1000000,
58	"offsetNanoseconds": 1000000
59	},
60	"asset": "asset"
61	},
62	"dataReviewMetrics": {
63	"checks": {
64	"pendingExecution": 1,
65	"executing": 1,
66	"passingAutomatic": 1,
67	"pendingReview": 1,
68	"closedWithIgnore": 1,
69	"closedWithFurtherAction": 1,
70	"failedToExecutePendingReview": 1,
71	"failedToExecuteClosedWithIgnore": 1,
72	"failedToExecuteClosedWithFurtherAction": 1
73	},
74	"alerts": {
75	"pendingReview": 1,
76	"closedWithIgnore": 1,
77	"closedWithFurtherAction": 1
78	}
79	}
80	}