Get query

GET

Get query including paginated results if the query execution is complete

Path parameters

query_idstringRequired

The unique identifier for the query

Query parameters

offsetintegerOptional

Starting index to return in the results

limitintegerOptional

Max number of items to return in the results

exclude_resultsbooleanOptional

Optionally exclude results from the response

Response

This endpoint returns an object.

createdUserIdstring

The user that created the resource

createdDtdatetime

The created datetime of the resource

updatedUserIdstring

The user that last updated the resource

updatedDtdatetime

The datetime the resource was last updated

queryIdstring

The query id

querystring

The SQL query

datasetIdstring

The dataset id

statusenum

The current status of the query

startDtdatetimeOptional

The time the query started executing

endDtdatetimeOptional

The time the query finished executing

isActivebooleanOptional

Defines if the query is in an active state or not

resultobjectOptional

The result of the query

GET

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

200Retrieved

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

Built with

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

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