HubSpot: Pipeline governance schemas (part 1)

21 HubSpot schemas with complete fields and constraints.

← Pipeline governance operations · All schemas

Retrieve rules — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`approvalStage`	Model	Optional	Expand Retrieve rules — response body — approval Stage
`createdAt`	string	Required within parent	The date and time when the pipeline rule was created. Format: date-time
`governanceValidationRules`	Model	Required within parent	Expand Retrieve rules — response body — governance Validation Rules
`id`	string	Required within parent	The unique identifier for the pipeline rule.
`objectTypeId`	string	Required within parent	The identifier for the type of object the pipeline rule is associated with.
`pipelineId`	string	Required within parent	The unique identifier for the pipeline to which the rule applies.
`updatedAt`	string	Required within parent	The date and time when the pipeline rule was last updated. Format: date-time

Referenced models: Retrieve rules — response body — approval Stage, Retrieve rules — response body — governance Validation Rules

Retrieve rules — response body — approval Stage

Field	Type	Presence	Description and constraints
`$`	object	Root
`approvalComment`	string	Optional	A string that allows for an optional comment or note regarding the approval process.
`approvalMode`	string	Required within parent	Specifies the mode of approval required. It can be either 'ALL', meaning all approvers must approve, or 'ANY', meaning any one approver can approve. It is a string. Known values: ALL, ANY
`approverUserIds`	array	Required within parent	An array of user IDs representing the users who are designated as approvers for this stage. Each user ID is a string.
`approverUserIds[]`	string	Each item
`conditionalApprovalFilterBranch`	JSON	Optional	Defines the conditions under which the approval is required. It can be one of several filter branch types, such as PublicOrFilterBranch or PublicAndFilterBranch, which determine the logical conditions for approval.
`conditionalApprovalFilterBranch (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
`conditionalApprovalFilterBranch (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
`conditionalApprovalFilterBranch (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
`conditionalApprovalFilterBranch (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
`conditionalApprovalFilterBranch (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
`conditionalApprovalFilterBranch (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
`conditionalApprovalFilterBranch (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
`pipelineStageId`	string	Required within parent	The unique identifier for the pipeline stage that this approval rule applies to. It is a string.

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND

Field	Type	Presence	Description and constraints
`$`	object	Root
`filterBranchOperator`	string	Required within parent	A string representing the logical operator used in the filter branch.
`filterBranchType`	string	Required within parent	A string indicating the type of filter branch. Defaults to 'AND'. Known values: AND Default: AND
`filterBranches`	array	Required within parent	An array of nested filter branches, which can include 'OR', 'AND', 'NOT_ALL', 'NOT_ANY', 'RESTRICTED', 'UNIFIED_EVENTS', and 'ASSOCIATION' filter branches.
`filterBranches[]`	JSON	Each item
`filterBranches[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
`filterBranches[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
`filterBranches[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
`filterBranches[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
`filterBranches[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
`filterBranches[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
`filterBranches[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
`filters`	array	Required within parent	An array of filters that are applied within this branch. These can include various types of filters such as property filters, event filters, and subscription filters.
`filters[]`	JSON	Each item
`filters[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY
`filters[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
`filters[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
`filters[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
`filters[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
`filters[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
`filters[] (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
`filters[] (anyOf 10)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
`filters[] (anyOf 11)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
`filters[] (anyOf 12)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
`filters[] (anyOf 13)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
`filters[] (anyOf 14)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
`filters[] (anyOf 15)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY
`filters[] (anyOf 16)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
`filters[] (anyOf 17)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
`filters[] (anyOf 18)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST
`filters[] (anyOf 19)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
`filters[] (anyOf 20)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION

Field	Type	Presence	Description and constraints
`$`	object	Root
`associationCategory`	string	Required within parent	A string indicating the category of the association.
`associationTypeId`	JSON	Required within parent
`associationTypeId (anyOf 1)`	integer	Alternative	An integer representing the ID of the association type. Format: int32
`associationTypeId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`filterBranchOperator`	string	Required within parent	A string representing the operator used to combine the filter branches.
`filterBranchType`	string	Required within parent	A string indicating the type of filter branch, which is 'ASSOCIATION' by default. Known values: ASSOCIATION Default: ASSOCIATION
`filterBranches`	array	Required within parent	An array of filter branches that can include various types of branches such as OR, AND, NOT_ALL, NOT_ANY, RESTRICTED, UNIFIED_EVENTS, and ASSOCIATION.
`filterBranches[]`	JSON	Each item
`filterBranches[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
`filterBranches[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
`filterBranches[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
`filterBranches[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
`filterBranches[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
`filterBranches[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
`filterBranches[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
`filters`	array	Required within parent	An array of filters that can include different types of filters such as property filters, association filters, and various analytics filters.
`filters[]`	JSON	Each item
`filters[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY
`filters[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
`filters[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
`filters[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
`filters[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
`filters[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
`filters[] (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
`filters[] (anyOf 10)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
`filters[] (anyOf 11)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
`filters[] (anyOf 12)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
`filters[] (anyOf 13)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
`filters[] (anyOf 14)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
`filters[] (anyOf 15)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY
`filters[] (anyOf 16)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
`filters[] (anyOf 17)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
`filters[] (anyOf 18)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST
`filters[] (anyOf 19)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
`filters[] (anyOf 20)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT
`objectTypeId`	string	Required within parent	A string representing the ID of the object type involved in the association.
`operator`	string	Required within parent	A string representing the operator used in the filter branch.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL

Field	Type	Presence	Description and constraints
`$`	object	Root
`filterBranchOperator`	string	Required within parent	A string representing the operator used to combine the filter branches.
`filterBranchType`	string	Required within parent	A string indicating the type of filter branch, which is 'NOT_ALL' for this component. Known values: NOT_ALL Default: NOT_ALL
`filterBranches`	array	Required within parent	An array of filter branches that can include various types of filter branches such as 'OR', 'AND', 'NOT_ALL', etc.
`filterBranches[]`	JSON	Each item
`filterBranches[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
`filterBranches[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
`filterBranches[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
`filterBranches[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
`filterBranches[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
`filterBranches[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
`filterBranches[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
`filters`	array	Required within parent	An array of filters that can include various types of filters such as property filters, association filters, and more.
`filters[]`	JSON	Each item
`filters[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY
`filters[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
`filters[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
`filters[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
`filters[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
`filters[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
`filters[] (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
`filters[] (anyOf 10)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
`filters[] (anyOf 11)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
`filters[] (anyOf 12)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
`filters[] (anyOf 13)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
`filters[] (anyOf 14)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
`filters[] (anyOf 15)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY
`filters[] (anyOf 16)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
`filters[] (anyOf 17)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
`filters[] (anyOf 18)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST
`filters[] (anyOf 19)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
`filters[] (anyOf 20)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY

Field	Type	Presence	Description and constraints
`$`	object	Root
`filterBranchOperator`	string	Required within parent	A string representing the logical operator used within the filter branch.
`filterBranchType`	string	Required within parent	A string indicating the type of filter branch, which is 'NOT_ANY' for this component. Known values: NOT_ANY Default: NOT_ANY
`filterBranches`	array	Required within parent	An array of nested filter branches, each of which can be of various types including 'OR', 'AND', 'NOT_ALL', 'NOT_ANY', 'RESTRICTED', 'UNIFIED_EVENTS', and 'ASSOCIATION'.
`filterBranches[]`	JSON	Each item
`filterBranches[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
`filterBranches[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
`filterBranches[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
`filterBranches[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
`filterBranches[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
`filterBranches[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
`filterBranches[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
`filters`	array	Required within parent	An array of filters that can include different types such as property filters, association filters, and various analytics filters.
`filters[]`	JSON	Each item
`filters[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY
`filters[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
`filters[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
`filters[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
`filters[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
`filters[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
`filters[] (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
`filters[] (anyOf 10)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
`filters[] (anyOf 11)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
`filters[] (anyOf 12)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
`filters[] (anyOf 13)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
`filters[] (anyOf 14)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
`filters[] (anyOf 15)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY
`filters[] (anyOf 16)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
`filters[] (anyOf 17)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
`filters[] (anyOf 18)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST
`filters[] (anyOf 19)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
`filters[] (anyOf 20)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR

Field	Type	Presence	Description and constraints
`$`	object	Root
`filterBranchOperator`	string	Required within parent	A string representing the operator used in the filter branch.
`filterBranchType`	string	Required within parent	A string that specifies the type of filter branch, which is 'OR' by default. Known values: OR Default: OR
`filterBranches`	array	Required within parent	An array of filter branches that can include various types of filter branches such as 'OR', 'AND', 'NOT_ALL', 'NOT_ANY', 'RESTRICTED', 'UNIFIED_EVENTS', or 'ASSOCIATION'.
`filterBranches[]`	JSON	Each item
`filterBranches[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
`filterBranches[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
`filterBranches[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
`filterBranches[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
`filterBranches[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
`filterBranches[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
`filterBranches[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
`filters`	array	Required within parent	An array of filters that can include different types of filters such as 'PublicPropertyFilter', 'PublicAssociationInListFilter', 'PublicPageViewAnalyticsFilter', and others.
`filters[]`	JSON	Each item
`filters[] (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY
`filters[] (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
`filters[] (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
`filters[] (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
`filters[] (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
`filters[] (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
`filters[] (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
`filters[] (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
`filters[] (anyOf 10)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
`filters[] (anyOf 11)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
`filters[] (anyOf 12)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
`filters[] (anyOf 13)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
`filters[] (anyOf 14)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
`filters[] (anyOf 15)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY
`filters[] (anyOf 16)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
`filters[] (anyOf 17)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
`filters[] (anyOf 18)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST
`filters[] (anyOf 19)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
`filters[] (anyOf 20)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH

Field	Type	Presence	Description and constraints
`$`	object	Root
`adNetwork`	string	Required within parent	A string identifying the ad network where the search is performed.
`entityType`	string	Required within parent	A string representing the type of entity being filtered.
`filterType`	string	Required within parent	A string indicating the type of filter being applied. Default value is 'ADS_SEARCH'. Known values: ADS_SEARCH Default: ADS_SEARCH
`operator`	string	Required within parent	A string that specifies the operation or condition applied to the filter.
`searchTermType`	string	Required within parent	A string specifying the type of search term used in the filter.
`searchTerms`	array	Required within parent	An array of strings containing the terms used to search within the ad network.
`searchTerms[]`	string	Each item

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME

Field	Type	Presence	Description and constraints
`$`	object	Root
`filterType`	string	Required within parent	A string that indicates the type of filter being applied. The default value is 'ADS_TIME'. Known values: ADS_TIME Default: ADS_TIME
`pruningRefineBy`	JSON	Required within parent	An object that defines the criteria for refining the filter based on time attributes. It can be one of several types, such as PublicNumOccurrencesRefineBy, PublicSetOccurrencesRefineBy, or various timestamp refine types.
`pruningRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`pruningRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`pruningRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`pruningRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`pruningRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`pruningRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`pruningRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`pruningRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`pruningRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION

Field	Type	Presence	Description and constraints
`$`	object	Root
`associationCategory`	string	Required within parent	A string that specifies the category of the association.
`associationTypeId`	JSON	Required within parent
`associationTypeId (anyOf 1)`	integer	Alternative	An integer that identifies the type of association. Format: int32
`associationTypeId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`coalescingRefineBy`	JSON	Required within parent	An object that defines the criteria for refining the filter. It can be one of several types, such as PublicNumOccurrencesRefineBy or PublicTimePointOperation.
`coalescingRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`coalescingRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`coalescingRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`coalescingRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`coalescingRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`coalescingRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`coalescingRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`coalescingRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`coalescingRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
`filterType`	string	Required within parent	A string that specifies the type of filter. The default value is 'ASSOCIATION'. Known values: ASSOCIATION Default: ASSOCIATION
`listId`	string	Required within parent	A string that identifies the list to which the filter is applied.
`operator`	string	Required within parent	A string that represents the operator used in the filter.
`toObjectType`	string	Optional	A string that specifies the type of the object to which the association is made.
`toObjectTypeId`	string	Optional	A string that specifies the type ID of the object to which the association is made.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION

Field	Type	Presence	Description and constraints
`$`	object	Root
`acceptedOptStates`	array	Required within parent	An array of strings representing the accepted opt-in states for the subscription.
`acceptedOptStates[]`	string	Each item
`businessUnitId`	string	Optional	A string representing the ID of the business unit associated with the subscription.
`channel`	string	Required within parent	A string indicating the communication channel associated with the subscription.
`filterType`	string	Required within parent	A string that indicates the type of filter. The default value is 'COMMUNICATION_SUBSCRIPTION'. Known values: COMMUNICATION_SUBSCRIPTION Default: COMMUNICATION_SUBSCRIPTION
`subscriptionIds`	array	Required within parent	An array of strings representing the IDs of the subscriptions to be filtered.
`subscriptionIds[]`	string	Each item
`subscriptionType`	string	Required within parent	A string indicating the type of subscription.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT

Field	Type	Presence	Description and constraints
`$`	object	Root
`filterType`	string	Required within parent	A string indicating the type of filter. It defaults to 'CONSTANT' and must be one of the predefined filter types. Known values: CONSTANT Default: CONSTANT
`shouldAccept`	boolean	Required within parent	A boolean indicating whether the filter should accept the criteria it evaluates.
`source`	string	Optional	A string representing the origin or context from which the filter is applied.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA

Field	Type	Presence	Description and constraints
`$`	object	Root
`coalescingRefineBy`	JSON	Optional	An optional refinement criterion that can be one of several types, including occurrences and timestamp comparisons.
`coalescingRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`coalescingRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`coalescingRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`coalescingRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`coalescingRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`coalescingRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`coalescingRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`coalescingRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`coalescingRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
`ctaName`	string	Required within parent	A string representing the name of the Call-To-Action being filtered.
`filterType`	string	Required within parent	A string that specifies the type of filter, defaulting to 'CTA'. Known values: CTA Default: CTA
`operator`	string	Required within parent	A string that defines the operation to be applied in the filter.
`pruningRefineBy`	JSON	Optional	An optional refinement criterion used to narrow down data, similar to coalescingRefineBy, with options like occurrences and timestamp comparisons.
`pruningRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`pruningRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`pruningRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`pruningRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`pruningRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`pruningRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`pruningRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`pruningRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`pruningRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT

Field	Type	Presence	Description and constraints
`$`	object	Root
`appId`	string	Required within parent	A string that identifies the application associated with the email event.
`clickUrl`	string	Optional	A string representing the URL that was clicked in the email event.
`emailId`	string	Required within parent	A string that uniquely identifies the email associated with the event.
`filterType`	string	Required within parent	A string that specifies the type of filter. The default value is 'EMAIL_EVENT'. Known values: EMAIL_EVENT Default: EMAIL_EVENT
`level`	string	Required within parent	A string representing the level of the email event.
`operator`	string	Required within parent	A string that defines the operation or event type for filtering. Valid values include 'LINK_CLICKED', 'MARKED_SPAM', 'OPENED', 'OPENED_BUT_LINK_NOT_CLICKED', 'OPENED_BUT_NOT_REPLIED', 'REPLIED', 'UNSUBSCRIBED', 'BOUNCED', 'RECEIVED', 'RECEIVED_BUT_NOT_OPENED', 'SENT', 'SENT_BUT_LINK_NOT_CLICKED', and 'SENT_BUT_NOT_RECEIVED'. Known values: BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED
`pruningRefineBy`	JSON	Optional	An object that specifies additional criteria for refining the filter, which can be one of several types such as 'PublicNumOccurrencesRefineBy', 'PublicSetOccurrencesRefineBy', 'PublicRelativeComparativeTimestampRefineBy', 'PublicRelativeRangedTimestampRefineBy', 'PublicAbsoluteComparativeTimestampRefineBy', 'PublicAbsoluteRangedTimestampRefineBy', 'PublicAllHistoryRefineBy', 'PublicTimePointOperation', or 'PublicRangedTimeOperation'.
`pruningRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`pruningRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`pruningRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`pruningRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`pruningRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`pruningRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`pruningRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`pruningRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`pruningRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION

Field	Type	Presence	Description and constraints
`$`	object	Root
`acceptedStatuses`	array	Required within parent	An array of strings indicating the statuses that are accepted for the filter.
`acceptedStatuses[]`	string	Each item
`filterType`	string	Required within parent	A string indicating the type of filter, which is 'EMAIL_SUBSCRIPTION' for this component. Known values: EMAIL_SUBSCRIPTION Default: EMAIL_SUBSCRIPTION
`subscriptionIds`	array	Required within parent	An array of strings representing the IDs of the subscriptions to be filtered.
`subscriptionIds[]`	string	Each item
`subscriptionType`	string	Optional	A string representing the type of subscription.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT

Field	Type	Presence	Description and constraints
`$`	object	Root
`coalescingRefineBy`	JSON	Optional	An optional refinement criterion that can be one of several types, such as occurrences or timestamp comparisons, to further refine the filter results.
`coalescingRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`coalescingRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`coalescingRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`coalescingRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`coalescingRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`coalescingRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`coalescingRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`coalescingRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`coalescingRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
`eventId`	string	Required within parent	A string that uniquely identifies the event to be filtered.
`filterType`	string	Required within parent	A string indicating the type of filter, which is always 'EVENT' for this component. Known values: EVENT Default: EVENT
`operator`	string	Required within parent	A string representing the operation or condition applied in the filter.
`pruningRefineBy`	JSON	Optional	An optional refinement criterion similar to coalescingRefineBy, used to prune the filter results based on specific conditions.
`pruningRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`pruningRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`pruningRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`pruningRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`pruningRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`pruningRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`pruningRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`pruningRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`pruningRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT

Field	Type	Presence	Description and constraints
`$`	object	Root
`coalescingRefineBy`	JSON	Optional	Criteria used to refine the filter by coalescing, which can include various timestamp operations.
`coalescingRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`coalescingRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`coalescingRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`coalescingRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`coalescingRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`coalescingRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`coalescingRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`coalescingRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`coalescingRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
`filterType`	string	Required within parent	The type of filter being applied. Defaults to 'FORM_SUBMISSION_ON_PAGE'. Known values: FORM_SUBMISSION_ON_PAGE Default: FORM_SUBMISSION_ON_PAGE
`formId`	string	Optional	The unique identifier of the form being filtered.
`operator`	string	Required within parent	The operation to apply, which can be either 'FILLED_OUT' or 'NOT_FILLED_OUT'. Known values: FILLED_OUT, NOT_FILLED_OUT
`pageId`	string	Required within parent	The unique identifier of the page where the form submission is being filtered.
`pruningRefineBy`	JSON	Optional	Criteria used to refine the filter by pruning, which can include various timestamp operations.
`pruningRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`pruningRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`pruningRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`pruningRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`pruningRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`pruningRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`pruningRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`pruningRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`pruningRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT

Field	Type	Presence	Description and constraints
`$`	object	Root
`coalescingRefineBy`	JSON	Optional	An object used to refine the filter by coalescing criteria. It can be one of several types, such as occurrences or timestamp-based refinements.
`coalescingRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`coalescingRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`coalescingRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`coalescingRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`coalescingRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`coalescingRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`coalescingRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`coalescingRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`coalescingRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
`filterType`	string	Required within parent	A string that specifies the type of filter. The default value is 'FORM_SUBMISSION'. Known values: FORM_SUBMISSION Default: FORM_SUBMISSION
`formId`	string	Optional	A string representing the unique identifier of the form.
`operator`	string	Required within parent	A string that specifies the operation to apply, with valid values being 'FILLED_OUT' or 'NOT_FILLED_OUT'. Known values: FILLED_OUT, NOT_FILLED_OUT
`pruningRefineBy`	JSON	Optional	An object used to refine the filter by pruning criteria. It can be one of several types, such as occurrences or timestamp-based refinements.
`pruningRefineBy (anyOf 1)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
`pruningRefineBy (anyOf 2)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
`pruningRefineBy (anyOf 3)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
`pruningRefineBy (anyOf 4)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
`pruningRefineBy (anyOf 5)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
`pruningRefineBy (anyOf 6)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
`pruningRefineBy (anyOf 7)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
`pruningRefineBy (anyOf 8)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
`pruningRefineBy (anyOf 9)`	Model	Alternative	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST

Field	Type	Presence	Description and constraints
`$`	object	Root
`filterType`	string	Required within parent	A string that specifies the type of filter being applied. The default value is 'IN_LIST'. Known values: IN_LIST Default: IN_LIST
`listId`	string	Required within parent	A string representing the unique identifier of the list to be used in the filter.
`metadata`	Model	Optional	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata
`operator`	string	Required within parent	A string that defines the operator used in the filter.

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata

Field	Type	Presence	Description and constraints
`$`	object	Root
`id`	string	Required within parent	The unique identifier for the list. It is a string that specifies which list the filter is associated with.
`inListType`	string	Required within parent	A string representing the type of list used in the filter. This property defines the context or category of the list being referenced.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT

Field	Type	Presence	Description and constraints
`$`	object	Root
`eventTypeId`	JSON	Required within parent
`eventTypeId (anyOf 1)`	integer	Alternative	A string that uniquely identifies the type of event to be filtered. This property is used to specify which event type the filter applies to. Format: int32
`eventTypeId (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`filterLines`	array	Required within parent	An array of filter lines that contain the metadata for the event filter. Each item in the array is a detailed specification of the criteria used to filter events.
`filterLines[]`	Model	Each item	Expand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item
`filterType`	string	Required within parent	A string representing the type of filter. It is a required field and typically has a default value specific to the filter type. Known values: INTEGRATION_EVENT Default: INTEGRATION_EVENT

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item

Report an issue with this page