Validate a Report's Filter Syntax

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Report filters use Origami's Advanced Search syntax. This endpoint acts as a syntax validator and translator, checking if your filter is valid and showing you a human-readable description of what it will do.

The endpoint validates a filter string against a specific report's data structure and returns two key pieces of information:

  • Whether the filter syntax is valid (ValidStructure: true/false)
  • A human-readable English translation of the filter (e.g., "Status is equal to Open AND Loss Date is greater than or equal to 2024-01-01")

This allows you to test filters before submitting them in a report request, catch errors early, and verify the filter will produce the results you expect.

Path Params
integer
required

The ReportID of the report for which data is being requested.

Query Params
string
required

String representation of the filter to be validated on the report. The syntax for these filters follow the Origami Advanced Search syntax.

Responses
200

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json