Validate Formula Expression
POST/api/v2/report-builder/validate-formula
Validate a user-entered formula expression before saving. The formula is parsed via Symfony ExpressionLanguage against a whitelist of functions (IF, COALESCE, ROUND, NULLIF, etc.) and field references ({field_name}).
reports:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request body:
formula(string, required, max 2000): The expression to validatebase_entity(string, optional): Entity context for field reference resolutionavailable_columns(array, optional): Available columns in the current report for reference validation
Returns { valid: true } or { valid: false, error: '...' }. Rejects SQL-injection attempts and unknown field references.
Request
Responses
- 200
- 401
- 403
- 422
- 429
Successful response
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.