Search Runs

POST

Searches for runs that match the given ƒilters.

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 \
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       "rid": "rid",
5       "runNumber": 1000000,
6       "title": "title",
7       "description": "description",
8       "startTime": {
9         "secondsSinceEpoch": 1000000,
10         "offsetNanoseconds": 1000000
11       },
12       "properties": {
13         "properties": "properties"
14       },
15       "labels": [
16         "labels"
17       ],
18       "links": [
19         {
20           "url": "url",
21           "title": "title"
22         },
23         {
24           "url": "url",
25           "title": "title"
26         }
27       ],
28       "createdAt": "2024-01-15T09:30:00Z",
29       "updatedAt": "2024-01-15T09:30:00Z",
30       "dataSources": {
31         "dataSources": {
32           "dataSource": {
33             "type": "dataset",
34             "dataset": "dataSource"
35           },
36           "offset": {
37             "seconds": 1000000,
38             "nanos": 1000000,
39             "picos": 1
40           },
41           "refName": "refName",
42           "timestampType": "ABSOLUTE",
43           "seriesTags": {
44             "seriesTags": "seriesTags"
45           }
46         }
47       },
48       "attachments": [
49         "attachments"
50       ],
51       "assets": [
52         "assets",
53         "assets"
54       ],
55       "runPrefix": "runPrefix",
56       "authorRid": "authorRid",
57       "endTime": {
58         "secondsSinceEpoch": 1000000,
59         "offsetNanoseconds": 1000000
60       },
61       "asset": "asset"
62     },
63     {
64       "rid": "rid",
65       "runNumber": 1000000,
66       "title": "title",
67       "description": "description",
68       "startTime": {
69         "secondsSinceEpoch": 1000000,
70         "offsetNanoseconds": 1000000
71       },
72       "properties": {
73         "properties": "properties"
74       },
75       "labels": [
76         "labels"
77       ],
78       "links": [
79         {
80           "url": "url",
81           "title": "title"
82         },
83         {
84           "url": "url",
85           "title": "title"
86         }
87       ],
88       "createdAt": "2024-01-15T09:30:00Z",
89       "updatedAt": "2024-01-15T09:30:00Z",
90       "dataSources": {
91         "dataSources": {
92           "dataSource": {
93             "type": "dataset",
94             "dataset": "dataSource"
95           },
96           "offset": {
97             "seconds": 1000000,
98             "nanos": 1000000,
99             "picos": 1
100           },
101           "refName": "refName",
102           "timestampType": "ABSOLUTE",
103           "seriesTags": {
104             "seriesTags": "seriesTags"
105           }
106         }
107       },
108       "attachments": [
109         "attachments"
110       ],
111       "assets": [
112         "assets",
113         "assets"
114       ],
115       "runPrefix": "runPrefix",
116       "authorRid": "authorRid",
117       "endTime": {
118         "secondsSinceEpoch": 1000000,
119         "offsetNanoseconds": 1000000
120       },
121       "asset": "asset"
122     }
123   ],
124   "nextPageToken": "nextPageToken"
125 }

Search Runs With Data Review Metrics

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v1/search-runs \
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	"rid": "rid",
5	"runNumber": 1000000,
6	"title": "title",
7	"description": "description",
8	"startTime": {
9	"secondsSinceEpoch": 1000000,
10	"offsetNanoseconds": 1000000
11	},
12	"properties": {
13	"properties": "properties"
14	},
15	"labels": [
16	"labels"
17	],
18	"links": [
19	{
20	"url": "url",
21	"title": "title"
22	},
23	{
24	"url": "url",
25	"title": "title"
26	}
27	],
28	"createdAt": "2024-01-15T09:30:00Z",
29	"updatedAt": "2024-01-15T09:30:00Z",
30	"dataSources": {
31	"dataSources": {
32	"dataSource": {
33	"type": "dataset",
34	"dataset": "dataSource"
35	},
36	"offset": {
37	"seconds": 1000000,
38	"nanos": 1000000,
39	"picos": 1
40	},
41	"refName": "refName",
42	"timestampType": "ABSOLUTE",
43	"seriesTags": {
44	"seriesTags": "seriesTags"
45	}
46	}
47	},
48	"attachments": [
49	"attachments"
50	],
51	"assets": [
52	"assets",
53	"assets"
54	],
55	"runPrefix": "runPrefix",
56	"authorRid": "authorRid",
57	"endTime": {
58	"secondsSinceEpoch": 1000000,
59	"offsetNanoseconds": 1000000
60	},
61	"asset": "asset"
62	},
63	{
64	"rid": "rid",
65	"runNumber": 1000000,
66	"title": "title",
67	"description": "description",
68	"startTime": {
69	"secondsSinceEpoch": 1000000,
70	"offsetNanoseconds": 1000000
71	},
72	"properties": {
73	"properties": "properties"
74	},
75	"labels": [
76	"labels"
77	],
78	"links": [
79	{
80	"url": "url",
81	"title": "title"
82	},
83	{
84	"url": "url",
85	"title": "title"
86	}
87	],
88	"createdAt": "2024-01-15T09:30:00Z",
89	"updatedAt": "2024-01-15T09:30:00Z",
90	"dataSources": {
91	"dataSources": {
92	"dataSource": {
93	"type": "dataset",
94	"dataset": "dataSource"
95	},
96	"offset": {
97	"seconds": 1000000,
98	"nanos": 1000000,
99	"picos": 1
100	},
101	"refName": "refName",
102	"timestampType": "ABSOLUTE",
103	"seriesTags": {
104	"seriesTags": "seriesTags"
105	}
106	}
107	},
108	"attachments": [
109	"attachments"
110	],
111	"assets": [
112	"assets",
113	"assets"
114	],
115	"runPrefix": "runPrefix",
116	"authorRid": "authorRid",
117	"endTime": {
118	"secondsSinceEpoch": 1000000,
119	"offsetNanoseconds": 1000000
120	},
121	"asset": "asset"
122	}
123	],
124	"nextPageToken": "nextPageToken"
125	}