data

Read a bounded row sample of a named relation for the Explorer's preview UI.

Reads up to maxRows rows (clamped server-side to [1, 1000], defaulting to 1000) of one NAMED relation [database.]schema.table — never arbitrary caller SQL — for the Explorer's row-sample UI (DVT-1807/1809). Same typed-parts identifier validation as POST /v1/data/describe.

MUST resolve identity, the caller's-rights token, and the per-dashboard query role role-pin byte-for-byte the same way POST /v1/data/query does — a preview never diverges in privilege from a query on the same source. Same tenant gate and render-session source scoping as the query/describe/objects paths: a cross-tenant sourceId returns 404.

Never served from or written to the POST /v1/data/objects listing cache — every preview is a live warehouse read under the caller's own resolved identity.

post/v1/data/preview

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/data/preview
  • Auth: one of:
    • API key in cookie dvt_session
    • HTTP bearer

Request body

sourceIdstring required

Connection name or UUID (resolved per connection-as-code.md).

databasestring

Relation database part. Optional for Postgres (the connection is bound to one database); used to fully qualify a Snowflake relation. Identifier allowlist: letters, digits, _ or $, up to 255 chars.

schemastring required

Relation schema part. Identifier allowlist: letters, digits, _ or $, up to 255 chars.

tablestring required

Relation table part. Identifier allowlist: letters, digits, _ or $, up to 255 chars.

maxRowsinteger

Requested row cap. Clamped server-side to [1, 1000]; omit to default to 1000 ("first 1,000 rows").

Response

A bounded row sample of the relation.

Changes

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