Skip to main content
POST
Execute SQL query against Kafka topics

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body for executing a SQL query against Kafka topics.

sql
string
required

SQL query string (e.g., SELECT * FROM topic_name WHERE ... LIMIT 10)

Required string length: 1 - 10000
max_time_seconds
integer
default:30

Maximum execution time in seconds before the query is terminated

Required range: 1 <= x <= 120

Response

Successful Response

Response from executing a SQL query against a Kafka topic.

columns
string[]

Column names in the result set

rows
Rows · object[]

Result rows as dicts

metadata
KafkaSqlQueryResultMetadata · object

Metadata about query execution for the results panel.

error
string | null

Error message if the query failed