List Queries | Coactive AI

curl https://api.coactive.ai/api/v1/queries \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "meta": {
    "page": {
      "current_page": 1,
      "limit": 10,
      "offset": 0
    },
    "links": {
      "current": "https://api.coactive.ai/api/v1/queries?page=1&limit=10",
      "previous": "",
      "next": "https://api.coactive.ai/api/v1/queries?page=2&limit=10"
    }
  },
  "data": [
    {
      "query_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "query": "SELECT * FROM sales WHERE region = 'North America'",
      "type": "SQL",
      "status": "Complete",
      "results": "[{\"order_id\": 12345, \"amount\": 250.00, \"region\": \"North America\"}]",
      "dataset_id": "9b2d7f3e-8c4a-4f1a-9d3e-1a2b3c4d5e6f",
      "created_dt": "2024-04-10T13:59:50Z",
      "updated_dt": "2024-04-10T14:00:05Z",
      "created_user_id": "user_789",
      "start_dt": "2024-04-10T14:00:00Z",
      "end_dt": "2024-04-10T14:00:05Z",
      "total_row_count": 1,
      "parameters": {},
      "updated_user_id": "user_789"
    }
  ]
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

statusenum or nullOptional

All possible query status values

dataset_idstring or nullOptionalformat: "uuid"

exclude_no_codeboolean or nullOptional

exclude_codeboolean or nullOptional

query_typesenum or nullOptional

All possible query types

Allowed values:

offsetintegerOptionalDefaults to 0

limitintegerOptionalDefaults to 100

Request

This endpoint expects an object.

query_idslist of strings or nullOptional

user_idslist of strings or nullOptional

exclude_user_idslist of strings or nullOptional

Response

Successful Response

metaobject

Metadata for the set of data returned

datalist of objects

The paginated data

Errors

422

Unprocessable Entity Error