Skip to main content
POST
/
query
/
sql
Handler for SQL queries
curl --request POST \
  --url https://api.example.com/query/sql \
  --header 'Content-Type: application/json' \
  --data '
{
  "sql": "<string>",
  "include_history": true
}
'
{
  "app_id": "<string>",
  "collection": "<string>",
  "count": 1,
  "data": [
    "<unknown>"
  ],
  "query": "<string>"
}

Body

application/json

SQL Query Request

​
sql
string
required

SQL query string Format: SELECT ... FROM app::collection WHERE ... Example: "SELECT name, age FROM myapp::users WHERE age > 18 ORDER BY name LIMIT 10"

​
include_history
boolean

Include all versions of records (history)

  • true: Return all versions of each record (append-only mode)
  • false (default): Return only latest version of each record (deduplicated by user-defined "id" field)

Response

SQL query executed successfully

SQL Query Response

​
app_id
string
required

App ID extracted from query

​
collection
string
required

Collection name extracted from query

​
count
integer
required

Number of results returned

Required range: x >= 0
​
data
any[]
required

Query results

​
query
string
required

SQL query that was executed