Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
sandboxId
string
Minimum string length: 1
connectorId
integer<int32>
query
string
tqlPath
string
params
params · object

Represents a JSON object.

An unordered key-value map, intending to perfectly capture the semantics of a JSON object. This enables parsing any arbitrary JSON payload as a message field in ProtoJSON format.

This follows RFC 8259 guidelines for interoperable JSON: notably this type cannot represent large Int64 values or NaN/Infinity numbers, since the JSON format generally does not support those values in its number type.

If you do not intend to parse arbitrary JSON into your message, a custom typed message should be preferred instead of using this type.

maxRows
integer<int32>
dataframeName
string | null

Response

Success

dataframeName
string
numRows
numCols
preview
string