Authorizations
API Key authentication. Format: 'x-api-key: api_key'
Body
Serializer for SQL query execution request.
SQL query string to execute using standard SQL syntax (AWS Athena or GCP BigQuery depending on your organization's cloud provider)
Output format for query results. Options: 'csv' (default, universal compatibility) or 'parquet' (better compression and performance, recommended for large datasets)
csv- csvparquet- parquet
csv, parquet Additional options for the output format. Available options depend on your organization's cloud provider and selected mode:
AWS Organizations:
- CSV mode: No options supported (AWS Athena limitation)
- Parquet mode: 'compression' - Compression algorithm (default: 'SNAPPY', options: 'SNAPPY', 'GZIP', 'NONE')
GCP Organizations:
- CSV mode: 'delimiter' (default: ','), 'header' (default: true), 'compression' (optional: 'GZIP')
- Parquet mode: 'compression' - Compression algorithm (default: 'SNAPPY', options: 'SNAPPY', 'GZIP', 'NONE')
Example: {'compression': 'SNAPPY'} or {'delimiter': ';', 'header': true, 'compression': 'GZIP'}
Response
Serializer for SQL query execution response.
Query execution state
SUCCEEDED- SUCCEEDEDFAILED- FAILEDCANCELLED- CANCELLEDRUNNING- RUNNING
SUCCEEDED, FAILED, CANCELLED, RUNNING List of presigned URLs to download result files (1 hour expiration)
Amount of data scanned by the query (if succeeded)
Query execution time in milliseconds (if succeeded)
Error message (if failed)