Submit Query

POST 
/v1/query

Submit Query

Request

Header Parameters

Authorization string

application/json

Body

required

SQL query submission payload

language stringrequired

Possible values: [SQL]

query stringrequired

Possible values: non-empty

fakeResults booleanrequired
dryRun booleanrequired
useLocalCache booleanrequired
useAggregateCache booleanrequired
timeout stringrequired

Possible values: non-empty

context

object

required

environment

object

required

id stringrequired

Possible values: non-empty

project

object

required

name stringrequired

Possible values: non-empty

aggregation

object

required

useAggregates booleanrequired

genAggregates booleanrequired

Responses

200

The query has been successfully submitted.

application/json

Schema

Schema

query-id stringrequired

Possible values: non-empty

metadata

object

required

succeeded booleanrequired

wall-time numberrequired

error-message string

columns

object[]

required

Array [

type stringrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty

]

data array[]required

Example (from schema)

{
  "query-id": "string",
  "metadata": {
    "succeeded": true,
    "wall-time": 0,
    "error-message": "string",
    "columns": [
      {
        "type": "string",
        "name": "string"
      }
    ]
  },
  "data": [
    [
      "string"
    ]
  ]
}

400

Invalid request for example: Invalid parameters, missing parameters.

401

Unauthorized. This error will occur if calling user does not have access right for the API.

403

Forbidden. This error will occur if the user lacks the proper roles or permissions to perform this action.

404

Not found. The server cannot find the requested resource.

500

A server error occurred. Check the logs for more details.

Loading...