Skip to main content
POST
/
api
/
semantic-models
/
sql
/
preview
Preview Sql
curl --request POST \
  --url https://api.example.com/api/semantic-models/sql/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sql": "<string>",
  "limit": 50
}
'
{
  "columns": [
    "<string>"
  ],
  "rows": [
    {}
  ],
  "row_count": 123,
  "truncated": false
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request to preview SQL execution.

sql
string
required

SQL query to preview

limit
integer
default:50

Row limit

Required range: 1 <= x <= 1000

Response

SQL preview results

Response from SQL preview.

columns
string[]
required
rows
Rows · object[]
required
row_count
integer
required
truncated
boolean
default:false

Whether results were truncated