SQL Snapshot

List SQL Snapshot Queries

get

Returns all currently active SQL snapshot query executions. Each entry includes the query ID, SQL statement, execution start time, and current progress. Useful for monitoring and managing long-running queries.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Responses

200Success

application/json

idstring · uuidRequired

startedstring · date-timeRequired

finishedstring · date-timeOptional

sqlstringRequired

usernamestringRequired

statusstring · enumRequiredPossible values:

messagestringOptional

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{environment}/proxy/api/v1/sql/queries

GET /api/v1/environments/{environment}/proxy/api/v1/sql/queries HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "started": "2026-01-01T00:00:00.000Z",
    "finished": "2026-01-01T00:00:00.000Z",
    "sql": "text",
    "username": "text",
    "status": "Completed",
    "message": "text"
  }
]

Stop SQL Snapshot Query

delete

Cancels an in-progress SQL snapshot query execution. The query will be terminated and resources released. Use the query ID returned from the execute endpoint to identify the query to cancel.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

queryIdstring · uuidRequired

The SQL Snapshot query identifier

Responses

200Success

No content

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete/api/v1/environments/{environment}/proxy/api/v1/sql/execution/{queryId}

DELETE /api/v1/environments/{environment}/proxy/api/v1/sql/execution/{queryId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Topic Paging Details

get

Returns partition-level offset information for a Kafka topic, including the earliest and latest offsets for each partition. This information is useful for understanding data availability and planning query ranges.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Query parameters

tablestringRequired

The target table

Responses

200Success

application/json

labelstringRequired

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get/api/v1/environments/{environment}/proxy/api/v1/sql/paging

GET /api/v1/environments/{environment}/proxy/api/v1/sql/paging?table=text HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "tableName": {
      "value": "text"
    },
    "type": {
      "value": "text"
    },
    "label": "text",
    "partitions": [
      {
        "id": {
          "value": 1
        },
        "label": "text",
        "start": 1,
        "end": 1
      }
    ]
  }
]

Get Snapshot SQL Intellisense

post

Provides code completion, syntax validation, and schema suggestions for snapshot SQL queries. Returns available tables, columns, functions, and SQL keywords based on the cursor position. Supports multiple data connections.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

sqlstringRequired

caretintegerOptional

connectorIdstringOptional

Responses

200Success

application/json

inputstringRequired

caretintegerRequired

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post/api/v1/environments/{environment}/proxy/api/v1/sql/presentation

POST /api/v1/environments/{environment}/proxy/api/v1/sql/presentation HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "sql": "text",
  "caret": 1,
  "connectorId": "text"
}

{
  "input": "text",
  "caret": 1,
  "lints": [
    {
      "start": 1,
      "end": 1,
      "text": "text",
      "type": "Warning"
    }
  ],
  "suggestions": [
    {
      "display": "text",
      "text": "text",
      "start": 1,
      "end": 1,
      "type": "text",
      "description": "text",
      "highlightStart": 1,
      "highlightEnd": 1
    }
  ],
  "highlights": [
    {
      "start": 1,
      "end": 1,
      "text": "text",
      "type": "Keyword"
    }
  ],
  "tables": [
    {
      "tableName": {
        "value": "text"
      },
      "fields": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "statementsPositions": [
    {
      "index": 1,
      "start": 1,
      "end": 1
    }
  ]
}