Magidoc

FilterObjectType
Object

Fields

#

display

String !
Non-null

Display label for the filter.

fieldType

String !
Non-null

Expected arbitrary type indicator of field as a string, e.g 'Date', 'Integer', 'Money', or 'String' (only used as a guideline for formatting insights)

name

String !
Non-null

The name of the filter field in the query input.

placeholder

String !
Non-null

Optional placeholder for the filter.

required

Boolean !
Non-null

Is this filter required in the query input or not.

value

String

Transferred value for the filter.

Usages

#

References

#