Search Runs With Data Review Metrics

POST

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

Request

This endpoint expects an object.

sortobjectRequired

pageSizeintegerRequired

Will reject page sizes greater than 10k.

queryobjectRequired

nextPageTokenstringOptional

Response

This endpoint returns an object.

resultslist of objects

nextPageTokenstringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/scout/v1/search-runs-with-data-review-metrics \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "sort": {
6     "isDescending": true,
7     "field": "CREATED_AT"
8   },
9   "pageSize": 1,
10   "query": {
11     "type": "startTimeInclusive",
12     "startTimeInclusive": {
13       "secondsSinceEpoch": 1000000
14     }
15   }
16 }'

200Successful

1 {
2   "results": [
3     {
4       "run": {
5         "rid": "rid",
6         "runNumber": 1000000,
7         "title": "title",
8         "description": "description",
9         "startTime": {
10           "secondsSinceEpoch": 1000000,
11           "offsetNanoseconds": 1000000
12         },
13         "properties": {
14           "properties": "properties"
15         },
16         "labels": [
17           "labels"
18         ],
19         "links": [
20           {
21             "url": "url",
22             "title": "title"
23           },
24           {
25             "url": "url",
26             "title": "title"
27           }
28         ],
29         "createdAt": "2024-01-15T09:30:00Z",
30         "updatedAt": "2024-01-15T09:30:00Z",
31         "dataSources": {
32           "dataSources": {
33             "dataSource": {
34               "type": "dataset",
35               "dataset": "dataSource"
36             },
37             "offset": {
38               "seconds": 1000000,
39               "nanos": 1000000,
40               "picos": 1
41             },
42             "refName": "refName",
43             "timestampType": "ABSOLUTE",
44             "seriesTags": {
45               "seriesTags": "seriesTags"
46             }
47           }
48         },
49         "attachments": [
50           "attachments"
51         ],
52         "assets": [
53           "assets",
54           "assets"
55         ],
56         "runPrefix": "runPrefix",
57         "authorRid": "authorRid",
58         "endTime": {
59           "secondsSinceEpoch": 1000000,
60           "offsetNanoseconds": 1000000
61         },
62         "asset": "asset"
63       },
64       "dataReviewMetrics": {
65         "checks": {
66           "pendingExecution": 1,
67           "executing": 1,
68           "passingAutomatic": 1,
69           "pendingReview": 1,
70           "closedWithIgnore": 1,
71           "closedWithFurtherAction": 1,
72           "failedToExecutePendingReview": 1,
73           "failedToExecuteClosedWithIgnore": 1,
74           "failedToExecuteClosedWithFurtherAction": 1
75         },
76         "alerts": {
77           "pendingReview": 1,
78           "closedWithIgnore": 1,
79           "closedWithFurtherAction": 1
80         }
81       }
82     },
83     {
84       "run": {
85         "rid": "rid",
86         "runNumber": 1000000,
87         "title": "title",
88         "description": "description",
89         "startTime": {
90           "secondsSinceEpoch": 1000000,
91           "offsetNanoseconds": 1000000
92         },
93         "properties": {
94           "properties": "properties"
95         },
96         "labels": [
97           "labels"
98         ],
99         "links": [
100           {
101             "url": "url",
102             "title": "title"
103           },
104           {
105             "url": "url",
106             "title": "title"
107           }
108         ],
109         "createdAt": "2024-01-15T09:30:00Z",
110         "updatedAt": "2024-01-15T09:30:00Z",
111         "dataSources": {
112           "dataSources": {
113             "dataSource": {
114               "type": "dataset",
115               "dataset": "dataSource"
116             },
117             "offset": {
118               "seconds": 1000000,
119               "nanos": 1000000,
120               "picos": 1
121             },
122             "refName": "refName",
123             "timestampType": "ABSOLUTE",
124             "seriesTags": {
125               "seriesTags": "seriesTags"
126             }
127           }
128         },
129         "attachments": [
130           "attachments"
131         ],
132         "assets": [
133           "assets",
134           "assets"
135         ],
136         "runPrefix": "runPrefix",
137         "authorRid": "authorRid",
138         "endTime": {
139           "secondsSinceEpoch": 1000000,
140           "offsetNanoseconds": 1000000
141         },
142         "asset": "asset"
143       },
144       "dataReviewMetrics": {
145         "checks": {
146           "pendingExecution": 1,
147           "executing": 1,
148           "passingAutomatic": 1,
149           "pendingReview": 1,
150           "closedWithIgnore": 1,
151           "closedWithFurtherAction": 1,
152           "failedToExecutePendingReview": 1,
153           "failedToExecuteClosedWithIgnore": 1,
154           "failedToExecuteClosedWithFurtherAction": 1
155         },
156         "alerts": {
157           "pendingReview": 1,
158           "closedWithIgnore": 1,
159           "closedWithFurtherAction": 1
160         }
161       }
162     }
163   ],
164   "nextPageToken": "nextPageToken"
165 }

Search Runs With Data Review Summary

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/search-runs-with-data-review-metrics \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"sort": {
6	"isDescending": true,
7	"field": "CREATED_AT"
8	},
9	"pageSize": 1,
10	"query": {
11	"type": "startTimeInclusive",
12	"startTimeInclusive": {
13	"secondsSinceEpoch": 1000000
14	}
15	}
16	}'

1	{
2	"results": [
3	{
4	"run": {
5	"rid": "rid",
6	"runNumber": 1000000,
7	"title": "title",
8	"description": "description",
9	"startTime": {
10	"secondsSinceEpoch": 1000000,
11	"offsetNanoseconds": 1000000
12	},
13	"properties": {
14	"properties": "properties"
15	},
16	"labels": [
17	"labels"
18	],
19	"links": [
20	{
21	"url": "url",
22	"title": "title"
23	},
24	{
25	"url": "url",
26	"title": "title"
27	}
28	],
29	"createdAt": "2024-01-15T09:30:00Z",
30	"updatedAt": "2024-01-15T09:30:00Z",
31	"dataSources": {
32	"dataSources": {
33	"dataSource": {
34	"type": "dataset",
35	"dataset": "dataSource"
36	},
37	"offset": {
38	"seconds": 1000000,
39	"nanos": 1000000,
40	"picos": 1
41	},
42	"refName": "refName",
43	"timestampType": "ABSOLUTE",
44	"seriesTags": {
45	"seriesTags": "seriesTags"
46	}
47	}
48	},
49	"attachments": [
50	"attachments"
51	],
52	"assets": [
53	"assets",
54	"assets"
55	],
56	"runPrefix": "runPrefix",
57	"authorRid": "authorRid",
58	"endTime": {
59	"secondsSinceEpoch": 1000000,
60	"offsetNanoseconds": 1000000
61	},
62	"asset": "asset"
63	},
64	"dataReviewMetrics": {
65	"checks": {
66	"pendingExecution": 1,
67	"executing": 1,
68	"passingAutomatic": 1,
69	"pendingReview": 1,
70	"closedWithIgnore": 1,
71	"closedWithFurtherAction": 1,
72	"failedToExecutePendingReview": 1,
73	"failedToExecuteClosedWithIgnore": 1,
74	"failedToExecuteClosedWithFurtherAction": 1
75	},
76	"alerts": {
77	"pendingReview": 1,
78	"closedWithIgnore": 1,
79	"closedWithFurtherAction": 1
80	}
81	}
82	},
83	{
84	"run": {
85	"rid": "rid",
86	"runNumber": 1000000,
87	"title": "title",
88	"description": "description",
89	"startTime": {
90	"secondsSinceEpoch": 1000000,
91	"offsetNanoseconds": 1000000
92	},
93	"properties": {
94	"properties": "properties"
95	},
96	"labels": [
97	"labels"
98	],
99	"links": [
100	{
101	"url": "url",
102	"title": "title"
103	},
104	{
105	"url": "url",
106	"title": "title"
107	}
108	],
109	"createdAt": "2024-01-15T09:30:00Z",
110	"updatedAt": "2024-01-15T09:30:00Z",
111	"dataSources": {
112	"dataSources": {
113	"dataSource": {
114	"type": "dataset",
115	"dataset": "dataSource"
116	},
117	"offset": {
118	"seconds": 1000000,
119	"nanos": 1000000,
120	"picos": 1
121	},
122	"refName": "refName",
123	"timestampType": "ABSOLUTE",
124	"seriesTags": {
125	"seriesTags": "seriesTags"
126	}
127	}
128	},
129	"attachments": [
130	"attachments"
131	],
132	"assets": [
133	"assets",
134	"assets"
135	],
136	"runPrefix": "runPrefix",
137	"authorRid": "authorRid",
138	"endTime": {
139	"secondsSinceEpoch": 1000000,
140	"offsetNanoseconds": 1000000
141	},
142	"asset": "asset"
143	},
144	"dataReviewMetrics": {
145	"checks": {
146	"pendingExecution": 1,
147	"executing": 1,
148	"passingAutomatic": 1,
149	"pendingReview": 1,
150	"closedWithIgnore": 1,
151	"closedWithFurtherAction": 1,
152	"failedToExecutePendingReview": 1,
153	"failedToExecuteClosedWithIgnore": 1,
154	"failedToExecuteClosedWithFurtherAction": 1
155	},
156	"alerts": {
157	"pendingReview": 1,
158	"closedWithIgnore": 1,
159	"closedWithFurtherAction": 1
160	}
161	}
162	}
163	],
164	"nextPageToken": "nextPageToken"
165	}