Search Runs With Data Review Summary

POST

Searches for runs that match the given filters and includes a summary of the data 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-summary \
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       "dataReviewSummary": {
65         "evaluationStatus": "NO_CHECKS_APPLIED",
66         "totalIssueCount": 1,
67         "reviewedIssueCount": 1,
68         "issuesWithFurtherActionCount": 1,
69         "executionErrorCount": 1
70       }
71     },
72     {
73       "run": {
74         "rid": "rid",
75         "runNumber": 1000000,
76         "title": "title",
77         "description": "description",
78         "startTime": {
79           "secondsSinceEpoch": 1000000,
80           "offsetNanoseconds": 1000000
81         },
82         "properties": {
83           "properties": "properties"
84         },
85         "labels": [
86           "labels"
87         ],
88         "links": [
89           {
90             "url": "url",
91             "title": "title"
92           },
93           {
94             "url": "url",
95             "title": "title"
96           }
97         ],
98         "createdAt": "2024-01-15T09:30:00Z",
99         "updatedAt": "2024-01-15T09:30:00Z",
100         "dataSources": {
101           "dataSources": {
102             "dataSource": {
103               "type": "dataset",
104               "dataset": "dataSource"
105             },
106             "offset": {
107               "seconds": 1000000,
108               "nanos": 1000000,
109               "picos": 1
110             },
111             "refName": "refName",
112             "timestampType": "ABSOLUTE",
113             "seriesTags": {
114               "seriesTags": "seriesTags"
115             }
116           }
117         },
118         "attachments": [
119           "attachments"
120         ],
121         "assets": [
122           "assets",
123           "assets"
124         ],
125         "runPrefix": "runPrefix",
126         "authorRid": "authorRid",
127         "endTime": {
128           "secondsSinceEpoch": 1000000,
129           "offsetNanoseconds": 1000000
130         },
131         "asset": "asset"
132       },
133       "dataReviewSummary": {
134         "evaluationStatus": "NO_CHECKS_APPLIED",
135         "totalIssueCount": 1,
136         "reviewedIssueCount": 1,
137         "issuesWithFurtherActionCount": 1,
138         "executionErrorCount": 1
139       }
140     }
141   ],
142   "nextPageToken": "nextPageToken"
143 }

Archive Run

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/search-runs-with-data-review-summary \
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	"dataReviewSummary": {
65	"evaluationStatus": "NO_CHECKS_APPLIED",
66	"totalIssueCount": 1,
67	"reviewedIssueCount": 1,
68	"issuesWithFurtherActionCount": 1,
69	"executionErrorCount": 1
70	}
71	},
72	{
73	"run": {
74	"rid": "rid",
75	"runNumber": 1000000,
76	"title": "title",
77	"description": "description",
78	"startTime": {
79	"secondsSinceEpoch": 1000000,
80	"offsetNanoseconds": 1000000
81	},
82	"properties": {
83	"properties": "properties"
84	},
85	"labels": [
86	"labels"
87	],
88	"links": [
89	{
90	"url": "url",
91	"title": "title"
92	},
93	{
94	"url": "url",
95	"title": "title"
96	}
97	],
98	"createdAt": "2024-01-15T09:30:00Z",
99	"updatedAt": "2024-01-15T09:30:00Z",
100	"dataSources": {
101	"dataSources": {
102	"dataSource": {
103	"type": "dataset",
104	"dataset": "dataSource"
105	},
106	"offset": {
107	"seconds": 1000000,
108	"nanos": 1000000,
109	"picos": 1
110	},
111	"refName": "refName",
112	"timestampType": "ABSOLUTE",
113	"seriesTags": {
114	"seriesTags": "seriesTags"
115	}
116	}
117	},
118	"attachments": [
119	"attachments"
120	],
121	"assets": [
122	"assets",
123	"assets"
124	],
125	"runPrefix": "runPrefix",
126	"authorRid": "authorRid",
127	"endTime": {
128	"secondsSinceEpoch": 1000000,
129	"offsetNanoseconds": 1000000
130	},
131	"asset": "asset"
132	},
133	"dataReviewSummary": {
134	"evaluationStatus": "NO_CHECKS_APPLIED",
135	"totalIssueCount": 1,
136	"reviewedIssueCount": 1,
137	"issuesWithFurtherActionCount": 1,
138	"executionErrorCount": 1
139	}
140	}
141	],
142	"nextPageToken": "nextPageToken"
143	}