Preview Operations

Get preview results by id.

Requires a bearer token for getting a data plane preview issued by the control plane API. Also requires the decodable-token header, which is provided by the data plane and signed to prevent tampering.

get/sql/preview

Request

Base URL
https://replace-with-account.api.data.decodable.co/v1alpha2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/decodable/apis/decodable-data-plane/docs/sql/preview/get.ts
A function with typed inputs. Its response is checked against the schema.

Headers

decodable-tokenstring required

An encoded token provided when a preview is created or fetched (if additional results from the preview are expected)

Response

A preview get response.

idstring required

An opaque ID, created by Decodable, that uniquely identifies a resource.

output_stream_type'APPEND' | 'CHANGE'

resultsobject[]

Result rows from preview.

next_tokenstring

A token used to fetch the next available results.

Example response

{
  "id": "abcd1234"
}

Changes

No recorded changes to this operation across all 1 revision of this API.