Skip to content

feat: SQL API query -> REST API query conversion #10201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+26 −0
Open

feat: SQL API query -> REST API query conversion #10201

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01e4b46
docs: SQL API query -> REST API query conversion
igorlukanin Nov 28, 2025
9a7d793
.
igorlukanin Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/pages/product/apis-integrations/rest-api/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,32 @@ values.

</WarningBox>

## `{base_path}/v1/convert`

Takes an API query in `input` format and converts it to the specified `output` format.
This endpoint is useful for converting queries, such as from the REST API format to the
SQL API format.

Request parameters:

| Parameter, type | Description | Required |
| --- | --- | --- |
| `input`, `string` | Input query format:<br/>`sql` for [SQL API][ref-sql-api] queries. | ✅ Yes |
| `output`, `string` | Output query format:<br/>`rest` for [REST API][ref-rest-api] queries. | ✅ Yes |
| `query`, `string` | Input query | ✅ Yes |

The response will contain a JSON object with the following properties:

| Property, type | Description |
| --- | --- |
| `status`, `string` | Query conversion status, `ok` or `error` |
| `query`, `object` | Converted query |
| `error`, `string` | Error message in case of an error |

An error will be returned if the input query can't be converted to the specified
output format, e.g., if the input SQL API query requires post-processing on top of REST API
capabilities or if the input SQL API query results in multiple REST API queries.

## `{base_path}/v1/sql`

Takes an API query and returns the SQL query that can be executed against the data source
Expand Down