Execute SQL query

Execute a read-only SELECT query against the workspace’s storage warehouse. Tables must be referenced as [datasetSlug].[modelSlug] and are rewritten to the underlying warehouse table under the hood.

POST /storage/query

Execute SQL query

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/storage/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>"
}
'

200

{
  "rows": [
    {}
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Request body schema.

query · string · required

A read-only SELECT statement. Tables must be referenced as [datasetSlug].[modelSlug] and are rewritten to the underlying warehouse table under the hood. Example: "SELECT count() FROM my_dataset.my_model"

Maximum string length: 10000

Response

200

application/json

Successful response

rows · Rows · object[] · required

Result rows.

Show child attributes