v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Object fields

Preview formula evaluation

Previews formula evaluation on existing data. Requires a USER API key with ADMIN or OWNER role.

post/public/v1/objects/{name}/fields/preview-formula

Path parameters

namestring required

Example:deals

Request body

previewFilterobject

Filter for preview rows

limitinteger

Example request

{
  "limit": 1
}

Response

Formula preview evaluation results

oktrue required

Example response

{
  "ok": true,
  "data": {
    "results": [
      {
        "rowId": "example",
        "rowName": "example",
        "previewState": {
          "error": "example"
        }
      }
    ],
    "inferredOutputType": "example"
  }
}