---
title: "Get a preview of the data on the stream."
method: GET
path: "/streams/{id}/preview"
tags: ["Stream Operations"]
---

# Get a preview of the data on the stream.

`GET /streams/{id}/preview`

## Request

- Base URL: `https://replace-with-account.api.data.decodable.co/v1alpha2`
- URL: `https://replace-with-account.api.data.decodable.co/v1alpha2/streams/{id}/preview`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/decodable/apis/decodable-data-plane/docs/streams/:id/preview/get.ts> (a function with typed inputs; its response is checked against the schema)

Requires a bearer token for data plane stream preview issued by the control plane API.

## Response `200`

A stream preview response.

- StreamPreview: A stream preview response.
  - `results` object[], required: Result rows from preview.
    - `_timestamp` integer, required: The processing time as a unix timestamp in milliseconds
    - `key` object: The record's primary key
    - `value` object, required: The record value

## Other responses

- `403`: Access denied: request is not permitted.
- `404`: The requested resource does not exist.
- `default`: An error has occurred.

---

[API](https://skmtc.dev/decodable/apis/decodable-data-plane.md) - [All operations](https://skmtc.dev/decodable/apis/decodable-data-plane/llms.txt) - [OpenAPI document](https://skmtc.dev/decodable/apis/decodable-data-plane/revisions/4303384f9994?raw)