List queries

GET

Get paginated list of queries. If query ids are provided, the returned list will include only those queries. Queries not found from the provided ids list will be ignored.

Query parameters

offsetintegerOptional

Starting index to return

limitintegerOptional

Max number of items to return

idsstringOptional

Query ids to include in the result

Response

This endpoint returns an object.

metaobject

Metadata for the set of data returned

datalist of objects

The paginated data

GET

1 curl https://app.coactive.ai/api/v1/queries \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "meta": {
3     "page": {
4       "currentPage": 1,
5       "limit": 10,
6       "offset": 0,
7       "lastPage": 10,
8       "total": 100
9     },
10     "links": {
11       "prev": "prev",
12       "next": "/api/list?limit=10&offset=10",
13       "first": "/api/list?limit=10&offset=0",
14       "last": "/api/list?limit=10&offset=90"
15     },
16     "sort": [
17       {
18         "direction": "asc",
19         "field": "name"
20       }
21     ]
22   },
23   "data": [
24     {
25       "createdUserId": "user_example",
26       "createdDt": "2018-09-11T15:11:45Z",
27       "updatedUserId": "user_example",
28       "updatedDt": "2018-09-11T15:11:45Z",
29       "queryId": "57552f03-87af-4847-a83e-e46a320af0c2",
30       "query": "select * from coactive_images_table",
31       "datasetId": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
32       "status": "Running",
33       "startDt": "2018-09-11T15:11:45Z",
34       "endDt": "2018-09-11T15:11:48Z",
35       "isActive": false
36     }
37   ]
38 }

Built with

1	curl https://app.coactive.ai/api/v1/queries \
2	-H "Authorization: Bearer <token>"

1	{
2	"meta": {
3	"page": {
4	"currentPage": 1,
5	"limit": 10,
6	"offset": 0,
7	"lastPage": 10,
8	"total": 100
9	},
10	"links": {
11	"prev": "prev",
12	"next": "/api/list?limit=10&offset=10",
13	"first": "/api/list?limit=10&offset=0",
14	"last": "/api/list?limit=10&offset=90"
15	},
16	"sort": [
17	{
18	"direction": "asc",
19	"field": "name"
20	}
21	]
22	},
23	"data": [
24	{
25	"createdUserId": "user_example",
26	"createdDt": "2018-09-11T15:11:45Z",
27	"updatedUserId": "user_example",
28	"updatedDt": "2018-09-11T15:11:45Z",
29	"queryId": "57552f03-87af-4847-a83e-e46a320af0c2",
30	"query": "select * from coactive_images_table",
31	"datasetId": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
32	"status": "Running",
33	"startDt": "2018-09-11T15:11:45Z",
34	"endDt": "2018-09-11T15:11:48Z",
35	"isActive": false
36	}
37	]
38	}