Skip to content

HubSpot: Pipeline governance schemas (part 2)

38 HubSpot schemas with complete fields and constraints.

← Pipeline governance operations · All schemas

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

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional refinement criterion that can be one of several predefined schemas, used to further refine the filter results.
coalescingRefineBy (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (anyOf 8)ModelAlternativeExpand 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)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
enableTrackingbooleanOptionalA boolean indicating whether tracking is enabled for this filter.
filterTypestringRequired within parentA string representing the type of filter. Default value is 'PAGE_VIEW'.
Known values: PAGE_VIEW
Default: PAGE_VIEW
operatorstringRequired within parentA string representing the operator used in the filter.
pageUrlstringRequired within parentA string representing the URL of the page to be filtered.
pruningRefineByJSONOptionalAn optional refinement criterion that can be one of several predefined schemas, used to prune the filter results.
pruningRefineBy (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (anyOf 8)ModelAlternativeExpand 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)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, 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: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

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

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string indicating the type of filter, which is 'PRIVACY' for this component.
Known values: PRIVACY
Default: PRIVACY
operatorstringRequired within parentA string specifying the operator to be used in conjunction with the privacyName for filtering.
privacyNamestringRequired within parentA string representing the name of the privacy setting to be used in the filter.

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

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string indicating the type of filter. The default value is 'PROPERTY'.
Known values: PROPERTY
Default: PROPERTY
operationJSONRequired within parentDefines the operation to be performed on the property. This can be one of several operation types, such as boolean, number, string, date, and more, each with its own specific behavior.
operation (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL
operation (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
operation (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
operation (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
operation (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
operation (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
operation (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
operation (anyOf 8)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
operation (anyOf 9)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
operation (anyOf 10)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
operation (anyOf 11)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY
operation (anyOf 12)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
operation (anyOf 13)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
operation (anyOf 14)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
operation (anyOf 15)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
operation (anyOf 16)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
operation (anyOf 17)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
operation (anyOf 18)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING
operation (anyOf 19)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
propertystringRequired within parentA string representing the name of the property to be filtered.

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, 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: PROPERTY operation operation Type: ROLLING DATE RANGE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set for the property.
operationTypestringRequired within parentA string indicating the type of operation. The default and only valid value is 'ALL_PROPERTY_TYPES'.
Known values: ALL_PROPERTY
Default: ALL_PROPERTY
operatorstringRequired within parentA string representing the operator to be used in the operation.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string representing the type of operation. The default value is 'BOOLEAN'.
Known values: BOOL
Default: BOOL
operatorstringRequired within parentA string indicating the operator used in the boolean operation.
valuebooleanRequired within parentA boolean representing the value to be used in the operation.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE

FieldTypePresenceDescription and constraints
$objectRoot
fiscalYearStartstringOptionalA string indicating the start month of the fiscal year. Valid values include 'JANUARY', 'FEBRUARY', 'MARCH', 'APRIL', 'MAY', 'JUNE', 'JULY', 'AUGUST', 'SEPTEMBER', 'OCTOBER', 'NOVEMBER', and 'DECEMBER'.
Known values: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set for the property.
operationTypestringRequired within parentA string indicating the type of operation, which is always 'CALENDAR_DATE'.
Known values: CALENDAR_DATE
Default: CALENDAR_DATE
operatorstringRequired within parentA string representing the operator used in the operation.
timeUnitstringRequired within parentA string specifying the unit of time for the operation.
timeUnitCountJSONOptional
timeUnitCount (anyOf 1)integerAlternativeAn integer specifying the count of the time units for the operation.
Format: int32
timeUnitCount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
useFiscalYearbooleanOptionalA boolean indicating whether the fiscal year should be used.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE

FieldTypePresenceDescription and constraints
$objectRoot
comparisonPropertyNamestringRequired within parentA string specifying the name of the property to be used for comparison.
defaultComparisonValuestringOptionalA string representing the default value to be used for comparison if no other value is set.
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation. The default value is 'COMPARATIVE_DATE'.
Known values: COMPARATIVE_DATE
Default: COMPARATIVE_DATE
operatorstringRequired within parentA string representing the operator used for comparison.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED

FieldTypePresenceDescription and constraints
$objectRoot
comparisonPropertyNamestringRequired within parentA string representing the name of the property to compare against.
defaultComparisonValuestringOptionalAn optional value used as a default for comparison if the comparison property is not set.
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects without a value set for the property should be included in the operation.
operationTypestringRequired within parentA string that specifies the type of operation. The default value is 'COMPARATIVE_PROPERTY_UPDATED'.
Known values: COMPARATIVE_PROPERTY_UPDATED
Default: COMPARATIVE_PROPERTY_UPDATED
operatorstringRequired within parentA string that defines the operator used in the comparison.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING

FieldTypePresenceDescription and constraints
$objectRoot
comparisonPropertyNamestringRequired within parentA string specifying the name of the property to be compared.
defaultComparisonValuestringOptionalThe default value to be used for comparison if the property value is not set, represented as a string.
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set for the property.
operationTypestringRequired within parentA string indicating the type of operation, which is 'COMPARATIVE_STRING' by default.
Known values: COMPARATIVE_STRING
Default: COMPARATIVE_STRING
operatorstringRequired within parentThe operator used for the comparison operation. It is a string value.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE

FieldTypePresenceDescription and constraints
$objectRoot
dayJSONRequired within parent
day (anyOf 1)integerAlternativeAn integer representing the day involved in the date operation.
Format: int32
day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects without a set value should be included in the operation.
monthstringRequired within parentA string representing the month involved in the date operation.
operationTypestringRequired within parentA string indicating the type of operation, which is always 'DATE'.
Known values: DATE
Default: DATE
operatorstringRequired within parentA string representing the operator used in the date operation.
yearJSONRequired within parent
year (anyOf 1)integerAlternativeAn integer representing the year involved in the date operation.
Format: int32
year (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects without a set value should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation, which is always 'DATETIME' for this component.
Known values: DATETIME
Default: DATETIME
operatorstringRequired within parentA string representing the operator used in the datetime operation.
requiresTimeZoneConversionbooleanRequired within parentA boolean specifying whether the datetime operation requires conversion based on time zones.
timestampJSONRequired within parent
timestamp (anyOf 1)integerAlternativeAn integer representing the timestamp involved in the operation, formatted as an int64.
Format: int64
timestamp (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string representing the type of operation, defaulting to 'ENUMERATION'.
Known values: ENUMERATION
Default: ENUMERATION
operatorstringRequired within parentA string indicating the operator used in the operation.
valuesarrayRequired within parentAn array of strings representing the values involved in the enumeration operation.
values[]stringEach item

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation, which is 'MULTISTRING' by default.
Known values: MULTISTRING
Default: MULTISTRING
operatorstringRequired within parentA string representing the operator used for the operation.
valuesarrayRequired within parentAn array of strings representing the values to be used in the operation.
values[]stringEach item

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation. The default value is 'NUMBER'.
Known values: NUMBER
Default: NUMBER
operatorstringRequired within parentA string representing the operator used in the operation.
valueJSONRequired within parent
value (anyOf 1)numberAlternativeA number representing the value used in the operation.
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that do not have a value set.
lowerBoundJSONRequired within parent
lowerBound (anyOf 1)integerAlternativeAn integer representing the lower bound of the range.
Format: int64
lowerBound (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
operationTypestringRequired within parentA string that specifies the type of operation. The default value is 'RANGED_NUMBER'.
Known values: NUMBER_RANGED
Default: NUMBER_RANGED
operatorstringRequired within parentA string representing the operator used in the operation.
upperBoundJSONRequired within parent
upperBound (anyOf 1)integerAlternativeAn integer representing the upper bound of the range.
Format: int64
upperBound (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects with no value set should be included.
lowerBoundJSONRequired within parent
lowerBound (anyOf 1)integerAlternativeAn integer representing the lower bound of the date range, in int64 format.
Format: int64
lowerBound (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
operationTypestringRequired within parentA string that specifies the type of operation, with a default value of 'RANGED_DATE'.
Known values: RANGED_DATE
Default: RANGED_DATE
operatorstringRequired within parentA string representing the operator used in the operation.
requiresTimeZoneConversionbooleanRequired within parentA boolean indicating whether the operation requires time zone conversion.
upperBoundJSONRequired within parent
upperBound (anyOf 1)integerAlternativeAn integer representing the upper bound of the date range, in int64 format.
Format: int64
upperBound (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that do not have a value set for the property being operated on.
numberOfDaysJSONRequired within parent
numberOfDays (anyOf 1)integerAlternativeAn integer specifying the number of days that define the rolling date range.
Format: int32
numberOfDays (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
operationTypestringRequired within parentA string indicating the type of operation, which is 'ROLLING_DATE_RANGE' by default.
Known values: ROLLING_DATE_RANGE
Default: ROLLING_DATE_RANGE
operatorstringRequired within parentA string representing the operator used in the operation.
requiresTimeZoneConversionbooleanRequired within parentA boolean indicating whether the operation requires conversion based on time zone.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set for the property.
numberOfDaysJSONRequired within parent
numberOfDays (anyOf 1)integerAlternativeAn integer specifying the number of days over which the rolling update operation is applied.
Format: int32
numberOfDays (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
operationTypestringRequired within parentA string indicating the type of operation. The default value is 'ROLLING_PROPERTY_UPDATED'.
Known values: ROLLING_PROPERTY_UPDATED
Default: ROLLING_PROPERTY_UPDATED
operatorstringRequired within parentA string representing the operator used in the operation.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether objects without a value set for the property should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation, which is always 'STRING' for this component.
Known values: STRING
Default: STRING
operatorstringRequired within parentA string representing the operator to be used in the operation. The specific operators are not detailed in the spec.
valuestringRequired within parentA string representing the value to be used in the operation.

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

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string that specifies the type of filter being used. The default value is 'SURVEY_MONKEY', indicating that this filter is for SurveyMonkey data.
Known values: SURVEY_MONKEY
Default: SURVEY_MONKEY
operatorstringRequired within parentA string that defines the operation or condition to apply when filtering the survey data.
surveyIdstringRequired within parentA string representing the unique identifier of the SurveyMonkey survey to be filtered.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string indicating the type of filter. Defaults to 'SURVEY_MONKEY_VALUE'.
Known values: SURVEY_MONKEY_VALUE
Default: SURVEY_MONKEY_VALUE
operatorstringRequired within parentA string that specifies the operator used in the filter, determining how the survey data is evaluated against the filter criteria.
surveyAnswerColIdstringOptionalA string representing the column identifier of the survey answer, used for filtering specific responses.
surveyAnswerRowIdstringOptionalA string representing the row identifier of the survey answer, used for filtering specific responses.
surveyIdstringRequired within parentA string representing the unique identifier of the SurveyMonkey survey.
surveyQuestionstringRequired within parentA string specifying the question within the survey to filter responses by.
valueComparisonJSONRequired within parentAn object that defines the operation for comparing survey answer values. It can be one of several types, such as number, string, or date operations.
valueComparison (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL
valueComparison (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
valueComparison (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
valueComparison (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
valueComparison (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
valueComparison (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
valueComparison (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
valueComparison (anyOf 8)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
valueComparison (anyOf 9)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
valueComparison (anyOf 10)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
valueComparison (anyOf 11)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY
valueComparison (anyOf 12)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
valueComparison (anyOf 13)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
valueComparison (anyOf 14)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
valueComparison (anyOf 15)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
valueComparison (anyOf 16)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
valueComparison (anyOf 17)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
valueComparison (anyOf 18)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING
valueComparison (anyOf 19)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, 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: PROPERTY operation operation Type: ROLLING DATE RANGE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER

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

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn object that specifies refinement criteria for coalescing events. It can be one of several predefined schemas such as PublicNumOccurrencesRefineBy or PublicTimePointOperation.
coalescingRefineBy (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (anyOf 8)ModelAlternativeExpand 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)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
eventTypeIdstringOptionalA string representing the unique identifier for the event type.
filterLinesarrayRequired within parentAn array of objects, each conforming to the PublicEventFilterMetadata schema, representing the individual filter lines that make up the unified events filter.
filterLines[]ModelEach itemExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item
filterTypestringRequired within parentA string indicating the type of filter. The default value is 'UNIFIED_EVENTS'.
Known values: UNIFIED_EVENTS
Default: UNIFIED_EVENTS
pruningRefineByJSONOptionalAn object that specifies refinement criteria for pruning events. It can be one of several predefined schemas such as PublicNumOccurrencesRefineBy or PublicTimePointOperation.
pruningRefineBy (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (anyOf 8)ModelAlternativeExpand 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)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, 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: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

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

FieldTypePresenceDescription and constraints
$objectRoot
operationJSONRequired within parentAn object that defines the operation to be performed on the specified property. This operation can be one of several types, such as boolean, number, string, or date operations, among others.
operation (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL
operation (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
operation (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
operation (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
operation (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
operation (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
operation (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
operation (anyOf 8)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
operation (anyOf 9)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
operation (anyOf 10)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
operation (anyOf 11)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY
operation (anyOf 12)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
operation (anyOf 13)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
operation (anyOf 14)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
operation (anyOf 15)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
operation (anyOf 16)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
operation (anyOf 17)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
operation (anyOf 18)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING
operation (anyOf 19)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
propertystringRequired within parentA string representing the specific property of the event that the filter is targeting.

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, 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: PROPERTY operation operation Type: ROLLING DATE RANGE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER

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

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string that specifies the type of filter. The default value is 'WEBINAR'.
Known values: WEBINAR
Default: WEBINAR
operatorstringRequired within parentA string representing the operator used in the filter.
webinarIdstringOptionalA string that uniquely identifies the webinar to be filtered.

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

FieldTypePresenceDescription and constraints
$objectRoot
filterBranchOperatorstringRequired within parentA string representing the operator used within the filter branch.
filterBranchTypestringRequired within parentA string indicating the type of the filter branch. Defaults to 'RESTRICTED'.
Known values: RESTRICTED
Default: RESTRICTED
filterBranchesarrayRequired within parentAn array of nested filter branches. Each item can be one of several types, including 'PublicOrFilterBranch', 'PublicAndFilterBranch', 'PublicNotAllFilterBranch', 'PublicNotAnyFilterBranch', 'PublicRestrictedFilterBranch', 'PublicUnifiedEventsFilterBranch', or 'PublicAssociationFilterBranch'.
filterBranches[]JSONEach item
filterBranches[] (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
filterBranches[] (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
filterBranches[] (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
filterBranches[] (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
filterBranches[] (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
filterBranches[] (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters applied within this branch. Each filter can be one of several types, such as 'PublicPropertyFilter', 'PublicAssociationInListFilter', 'PublicPageViewAnalyticsFilter', 'PublicCtaAnalyticsFilter', 'PublicEventAnalyticsFilter', 'PublicFormSubmissionFilter', 'PublicFormSubmissionOnPageFilter', 'PublicIntegrationEventFilter', 'PublicEmailSubscriptionFilter', 'PublicCommunicationSubscriptionFilter', 'PublicSurveyMonkeyFilter', 'PublicSurveyMonkeyValueFilter', 'PublicWebinarFilter', 'PublicEmailEventFilter', 'PublicPrivacyAnalyticsFilter', 'PublicAdsSearchFilter', 'PublicAdsTimeFilter', 'PublicInListFilter', 'PublicUnifiedEventsFilter', or 'PublicConstantFilter'.
filters[]JSONEach item
filters[] (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (anyOf 7)ModelAlternativeExpand 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)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (anyOf 9)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (anyOf 10)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (anyOf 11)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (anyOf 12)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (anyOf 13)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (anyOf 14)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (anyOf 15)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (anyOf 16)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (anyOf 17)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (anyOf 18)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (anyOf 19)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (anyOf 20)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, 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: CTA, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, 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: OR filters item filter Type: PAGE VIEW, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional refinement criterion that allows for additional filtering based on coalescing logic. This can be one of several predefined refinement schemas.
coalescingRefineBy (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (anyOf 8)ModelAlternativeExpand 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)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
eventTypeIdstringRequired within parentA string representing the unique identifier for the event type that this filter branch is targeting.
filterBranchOperatorstringRequired within parentA string that specifies the operator used to combine multiple filter branches within this component.
filterBranchTypestringRequired within parentA string indicating the type of filter branch, which is 'UNIFIED_EVENTS' for this component.
Known values: UNIFIED_EVENTS
Default: UNIFIED_EVENTS
filterBranchesarrayRequired within parentAn array of nested filter branches, each of which can be a complex filter structure involving various logical operators.
filterBranches[]JSONEach item
filterBranches[] (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR
filterBranches[] (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND
filterBranches[] (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ALL
filterBranches[] (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: NOT ANY
filterBranches[] (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED
filterBranches[] (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters that apply specific conditions to the unified events. Each filter can be one of several types, such as property filters or event analytics filters.
filters[]JSONEach item
filters[] (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (anyOf 7)ModelAlternativeExpand 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)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (anyOf 9)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (anyOf 10)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (anyOf 11)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (anyOf 12)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (anyOf 13)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (anyOf 14)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (anyOf 15)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (anyOf 16)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (anyOf 17)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (anyOf 18)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (anyOf 19)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (anyOf 20)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: CONSTANT
operatorstringRequired within parentA string that specifies the logical operator for the filter branch, with valid values including 'HAS_COMPLETED' and 'HAS_NOT_COMPLETED'.
Known values: HAS_COMPLETED, HAS_NOT_COMPLETED
pruningRefineByJSONOptionalAn optional refinement criterion that allows for additional filtering based on pruning logic. This can be one of several predefined refinement schemas.
pruningRefineBy (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (anyOf 8)ModelAlternativeExpand 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)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: AND, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: ASSOCIATION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, 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: CTA, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: EVENT, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: IN LIST, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, 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: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: PROPERTY, 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: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: RESTRICTED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: OR filters item filter Type: WEBINAR

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

FieldTypePresenceDescription and constraints
$objectRoot
endpointBehaviorstringOptionalA string describing the behavior of the endpoint in the context of the time point operation.
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects with no value set in the operation.
operationTypestringRequired within parentA string indicating the type of operation, defaulting to 'TIME_POINT'.
Known values: TIME_POINT
Default: TIME_POINT
operatorstringRequired within parentA string representing the operator used in the time point operation.
propertyParserstringOptionalA string specifying the parser used for the property in the operation.
timePointJSONRequired within parentDefines the specific time point for the operation. It can be one of several types, including PublicDatePoint, PublicIndexedTimePoint, or PublicPropertyReferencedTime.
timePoint (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE
timePoint (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED
timePoint (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED
typestringRequired within parentA string representing the type of the time point operation.

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE

FieldTypePresenceDescription and constraints
$objectRoot
dayJSONRequired within parent
day (anyOf 1)integerAlternativeAn integer representing the day component of the date.
Format: int32
day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONOptional
hour (anyOf 1)integerAlternativeAn integer representing the hour component of the time.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the millisecond component of the time.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute component of the time.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthJSONRequired within parent
month (anyOf 1)integerAlternativeAn integer representing the month component of the date.
Format: int32
month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second component of the time.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timeTypestringRequired within parentA string indicating the type of time representation.
Known values: DATE
Default: DATE
timezoneSourcestringOptionalA string specifying the source of the timezone information.
yearJSONRequired within parent
year (anyOf 1)integerAlternativeAn integer representing the year component of the date.
Format: int32
year (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
zoneIdstringRequired within parentA string representing the identifier for the timezone.

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED

FieldTypePresenceDescription and constraints
$objectRoot
indexReferenceJSONRequired within parentA reference point for indexing the time, which can be one of several predefined time references such as 'NOW', 'TODAY', 'WEEK', etc.
indexReference (anyOf 1)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: NOW
indexReference (anyOf 2)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: TODAY
indexReference (anyOf 3)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK
indexReference (anyOf 4)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL QUARTER
indexReference (anyOf 5)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL YEAR
indexReference (anyOf 6)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: YEAR
indexReference (anyOf 7)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: QUARTER
indexReference (anyOf 8)ModelAlternativeExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: MONTH
offsetModelOptionalExpand Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED offset
timeTypestringRequired within parentA string representing the type of time point, which is always 'INDEXED'.
Known values: INDEXED
Default: INDEXED
timezoneSourcestringOptionalA string indicating the source of the timezone information.
zoneIdstringRequired within parentA string representing the identifier for the timezone.

Referenced models: Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL QUARTER, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL YEAR, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED offset, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: MONTH, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: NOW, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: QUARTER, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: TODAY, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK, Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: YEAR

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK

FieldTypePresenceDescription and constraints
$objectRoot
dayOfWeekstringRequired within parentA string representing the day of the week. Valid values include 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY'.
Known values: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
hourJSONOptional
hour (anyOf 1)integerAlternativeAn integer representing the hour of the day.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the millisecond within the second.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute within the hour.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referenceTypestringRequired within parentA string indicating the type of reference, which is 'WEEK' by default.
Known values: WEEK
Default: WEEK
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second within the minute.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL QUARTER

FieldTypePresenceDescription and constraints
$objectRoot
dayJSONRequired within parent
day (anyOf 1)integerAlternativeAn integer representing the day of the month within the fiscal quarter.
Format: int32
day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONOptional
hour (anyOf 1)integerAlternativeAn integer representing the hour of the day.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the millisecond within the second.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute within the hour.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthJSONRequired within parent
month (anyOf 1)integerAlternativeAn integer representing the month of the fiscal quarter.
Format: int32
month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referenceTypestringRequired within parentA string indicating the type of reference, which is 'FISCAL_QUARTER' by default.
Known values: FISCAL_QUARTER
Default: FISCAL_QUARTER
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second within the minute.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL YEAR

FieldTypePresenceDescription and constraints
$objectRoot
dayJSONRequired within parent
day (anyOf 1)integerAlternativeAn integer representing the day component of the date.
Format: int32
day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONOptional
hour (anyOf 1)integerAlternativeAn integer representing the hour component of the time.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the millisecond component of the time.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute component of the time.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthJSONRequired within parent
month (anyOf 1)integerAlternativeAn integer representing the month component of the date.
Format: int32
month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referenceTypestringRequired within parentA string that specifies the type of reference, defaulting to 'FISCAL_YEAR'.
Known values: FISCAL_YEAR
Default: FISCAL_YEAR
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second component of the time.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: MONTH

FieldTypePresenceDescription and constraints
$objectRoot
dayJSONRequired within parent
day (anyOf 1)integerAlternativeAn integer representing the day of the month.
Format: int32
day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONOptional
hour (anyOf 1)integerAlternativeAn integer representing the hour of the day.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the millisecond within the second.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute within the hour.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referenceTypestringRequired within parentA string indicating the type of reference, which is 'MONTH' by default.
Known values: MONTH
Default: MONTH
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second within the minute.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: NOW

FieldTypePresenceDescription and constraints
$objectRoot
hourJSONOptional
hour (anyOf 1)integerAlternativeAn integer representing the hour of the current time.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the millisecond of the current time.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute of the current time.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referenceTypestringRequired within parentA string that indicates the type of reference, which is always 'NOW' for this component.
Known values: NOW
Default: NOW
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second of the current time.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: QUARTER

FieldTypePresenceDescription and constraints
$objectRoot
dayJSONRequired within parent
day (anyOf 1)integerAlternativeAn integer representing the day within the month.
Format: int32
day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONOptional
hour (anyOf 1)integerAlternativeAn integer representing the hour of the day.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the millisecond within the second.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute within the hour.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthJSONRequired within parent
month (anyOf 1)integerAlternativeAn integer representing the month within the quarter.
Format: int32
month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referenceTypestringRequired within parentA string indicating the type of reference, which is 'QUARTER' for this component.
Known values: QUARTER
Default: QUARTER
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second within the minute.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: TODAY

FieldTypePresenceDescription and constraints
$objectRoot
hourJSONOptional
hour (anyOf 1)integerAlternativeAn integer representing the hour of the day.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the millisecond within the second.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute within the hour.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referenceTypestringRequired within parentA string indicating the type of reference, which is 'TODAY' by default.
Known values: TODAY
Default: TODAY
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second within the minute.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: YEAR

FieldTypePresenceDescription and constraints
$objectRoot
dayJSONRequired within parent
day (anyOf 1)integerAlternativeAn integer representing the day of the month.
Format: int32
day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hourJSONOptional
hour (anyOf 1)integerAlternativeAn integer representing the hour of the day.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the millisecond within the second.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute within the hour.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthJSONRequired within parent
month (anyOf 1)integerAlternativeAn integer representing the month of the year.
Format: int32
month (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referenceTypestringRequired within parentA string that indicates the type of reference, which is 'YEAR' by default.
Known values: YEAR
Default: YEAR
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second within the minute.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve rules — response body — approvalStage / conditionalApprovalFilterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED offset

FieldTypePresenceDescription and constraints
$objectRoot
daysJSONOptional
days (anyOf 1)integerAlternativeAn integer representing the number of days for the offset.
Format: int32
days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hoursJSONOptional
hours (anyOf 1)integerAlternativeAn integer representing the number of hours for the offset.
Format: int32
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondsJSONOptional
milliseconds (anyOf 1)integerAlternativeAn integer representing the number of milliseconds for the offset.
Format: int32
milliseconds (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minutesJSONOptional
minutes (anyOf 1)integerAlternativeAn integer representing the number of minutes for the offset.
Format: int32
minutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthsJSONOptional
months (anyOf 1)integerAlternativeAn integer representing the number of months for the offset.
Format: int32
months (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quartersJSONOptional
quarters (anyOf 1)integerAlternativeAn integer representing the number of quarters for the offset.
Format: int32
quarters (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
secondsJSONOptional
seconds (anyOf 1)integerAlternativeAn integer representing the number of seconds for the offset.
Format: int32
seconds (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
weeksJSONOptional
weeks (anyOf 1)integerAlternativeAn integer representing the number of weeks for the offset.
Format: int32
weeks (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
yearsJSONOptional
years (anyOf 1)integerAlternativeAn integer representing the number of years for the offset.
Format: int32
years (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.