---
title: "Preview"
method: POST
path: "/companies/{company_id}/output-feeds/{output_feed_id}/preview"
tags: ["output feeds"]
---

# Preview

`POST /companies/{company_id}/output-feeds/{output_feed_id}/preview`

## Request

- Base URL: `https://app.zalster.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.zalster.com/companies/{company_id}/output-feeds/{output_feed_id}/preview`
- Auth: none declared

Render a handful of products exactly as the export would, writing nothing.

``rule_set_ids`` lets the page try a different selection before saving it;
omitted, the preview uses the sets the feed has actually selected — which is
what makes preview and export agree. Products are let through the same way:
by the product set the feed sends, read now, or by its own filter
(``feed_selection``), unless ``filter_document`` tries another filter first.

## Path parameters

- `company_id` string, uuid, required: Company id
- `output_feed_id` string, uuid, required: Output feed id

## Query parameters

- `theme` string, nullable: none, scheduled (the default: the company's theme now) or a theme's id
- `at` string, date-time, nullable: draw as at this moment, with a time zone; now when left out

## Request body

- PreviewRequest: Preview with the active documents, or try edits before saving them.
  - `document` object, nullable
  - `filter_document` object, nullable
  - `rule_set_ids` string[], nullable
  - `product_id` string, uuid, nullable
  - `limit` integer

## Response `200`

Successful Response

- PreviewOut
  - `columns` string[], required
  - `items` PreviewRow[], required
    - `product_id` string, uuid, required
    - `external_id` string, required
    - `included` boolean, required
    - `row` object, required
    - `computed` object, required
    - `fired_rules` string[], required
    - `errors` object[], required
    - `warnings` object[], required
  - `writable` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/zalster/apis/zalster-feed-processor.md) - [All operations](https://skmtc.dev/zalster/apis/zalster-feed-processor/llms.txt) - [OpenAPI document](https://skmtc.dev/zalster/apis/zalster-feed-processor/revisions/d0b9dc66ad36?raw)