Get your Ryft Ingest Token
Ryft will provide a unique ingest token for your environment. This token is required to authenticate requests to the Ingest API.Send Query Data
Send aPOST request to the ingest endpoint with your query data as JSON:
200 response means the message was accepted and will be processed.
Bulk Ingestion
You can send multiple queries in a single request by passing a JSON array instead of a single object:Payload Schema
| Field | Type | Required | Description |
|---|---|---|---|
context | object | yes | Query environment context. All fields within are optional — pass {} if no context is available. |
context.catalog | string | no | Catalog name (e.g. iceberg) |
context.schema | string | no | Default namespace for unqualified table names |
context.queryType | string | no | One of: SELECT, EXPLAIN, DESCRIBE, INSERT, UPDATE, DELETE, ANALYZE, DATA_DEFINITION, ALTER_TABLE_EXECUTE, MERGE |
context.serverVersion | string | no | Query engine version |
context.user | string | no | User or service account that ran the query |
context.userAgent | string | no | Client identifier |
query | string | yes | The SQL query text |
queryId | string | yes | Unique query identifier |
queryState | string | yes | Terminal query state: FINISHED, SUCCEEDED, or FAILED |
timestamp | string | yes | ISO 8601 timestamp of query execution |
duration_ms | number | yes | Execution time in milliseconds |
tags | string[] | no | Free-form labels for filtering in Query Explorer |
failureInfo | object or object[] | no | Only needed for failed queries (queryState: "FAILED"). Can be a single object or an array. |
failureInfo.errorCode.type | string | yes (within failureInfo) | One of: USER_ERROR, INTERNAL_ERROR, INSUFFICIENT_RESOURCES, EXTERNAL |
failureInfo.errorCode.code | number | no | Numeric error code (free-form) |
failureInfo.errorCode.name | string | no | Error name (free-form) |
failureInfo.failureMessage | string | no | Human-readable error description |
failureInfo.failureType | string | no | Exception or error class name |
Make sure outbound connectivity is enabled to
ingest.ryft.io on port 443 (HTTPS).