OBJECT
FilterBox
Group of filter conditions evaluated on records related to the main record type, reached through a lookup field or a predefined relation.
link GraphQL Schema definition
- type FilterBox implements FilterBoxInterface {
- # Identifier of this filter box within the filter tab.
- : String!
- # Name of the record type whose fields the conditions in this box are evaluated
- # against.
- : String!
- # Identifier of the lookup field that connects this box to the main record type
- # when the box filters a related record reached through a lookup.
- : UUID
- # Predefined relationship linking this sibling box to the main record type. Null
- # when the box is connected through a lookup field instead.
- : HardCodedRelation
- # Conditions evaluated on this box, each comparing one field against a set of
- # values.
- : [FieldFilterRule!]!
- }
link Require by
- AccountFilterTabFilter conditions that select which accounts a saved profile or report includes, combining conditions on the account with conditions on related records.
- ActivityFilterTabFilter conditions that select which activities (tasks and appointments) a saved profile or report includes, combining conditions on the activity with conditions on related records.
- ContactFilterTabFilter conditions that select which contacts a saved profile or report includes, combining conditions on the contact with conditions on related records.
- CustomEntityFilterTabFilter conditions that select which custom entity records a saved profile or report includes, combining conditions on the record with conditions on related records.
- EmailFilterTabFilter conditions an email must meet to appear in an email list or report.
- EmailSequenceFilterField conditions an email sequence checks against an enrolled record.
- EntityScoringRuleFilterConditions a record must meet for a scoring rule to award its score.
- FeedFilterTabFilter conditions that select which feed messages a report includes, combining conditions on the message with conditions on related records.
- FieldFilterFilter definition: conditions on a record type and on related records, grouped in filter boxes and combined with And, Or or a custom formula.
- FitnessCustomRuleRule of a custom fitness indicator: filter conditions that raise a warning level when a record matches them.
- LeadFilterTabFilter conditions that select which leads a saved profile or dashboard includes, combining conditions on the lead with conditions on related records.
- LeadOpportunityFilterTabFilter conditions that select which leads and opportunities a saved profile or report includes, combining conditions on the record with conditions on related records.
- NoteFilterTabFilter conditions that select which notes a saved profile or report includes, combining conditions on the note with conditions on related records.
- OpportunityFilterTabFilter conditions that select which opportunities a saved profile, forecast or dashboard item includes, combining conditions on the opportunity with conditions on related records.
- OpportunityKPIFilterTabFilter conditions that select which leads and opportunities the sales KPIs of a saved profile are calculated from.
- ProcessFilterNodeProcess node holding filter conditions; only the records that match them continue through the process.
- ProductFilterTabFilter conditions that select which products a saved profile or report includes, combining conditions on the product with conditions on related records.
- ProfileFilterBoxTabInterfaceFilter built from filter boxes: a main box on the record type and boxes on related records.
- ProfileFilterTabFilter made of a main box on the record type and boxes on related records, combined with And, Or or a custom formula.
- ProjectFilterTabFilter conditions that select which projects a saved profile or report includes, combining conditions on the project with conditions on related records.
- QuickFilterTabAd-hoc filter applied on top of the saved filter of a profile or report to narrow the records shown without changing the saved filter.
- QuoteFilterTabFilter conditions that select which quotes a saved profile or report includes, combining conditions on the quote with conditions on related records.
- StepChecklistVisibilityFilterConditions that decide when a step checklist item is shown; the item is visible only for records that match them.
- TimeframeFilterTabFilter conditions that select which timeframes (periods a lead or opportunity spent in a pipeline step) a saved profile or report includes, combining conditions on the timeframe with conditions on related records.