---
title: "Preview formula evaluation"
method: POST
path: "/public/v1/tables/{name}/fields/preview-formula"
tags: ["Table fields"]
---

# Preview formula evaluation

`POST /public/v1/tables/{name}/fields/preview-formula`

Previews formula evaluation on existing data. Requires a USER API key with edit access to the table.

## Path parameters

- `name` string, required

## Request body

- object
  - `formulaMetadata` object, required
    - `applyIf` object — Query preconditions filter
    - `expression` object — Formula expression AST. Maximum AST depth is 5 (root-to-leaf node count; root node is depth 1).
  - `previewFilter` object — Filter for preview rows
  - `limit` integer

## Response `200`

Formula preview evaluation results

- object
  - `ok` true, required
  - `data` object, required
    - `results` object[], required
      - `rowId` string, required
      - `rowName` string, required
      - `previewState` object, required
        - `value` object, nullable
        - `isValid` boolean, required
        - `error` string, nullable, required
      - `row` object, required
    - `inferredOutputType` string, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/getfrontline/apis/public-api.md) · [All operations](https://skmtc.net/getfrontline/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getfrontline/public-api/versions/9d33b6aad674/schema)