Skip to content

HubSpot: Object tags schemas (part 4)

30 HubSpot schemas with complete fields and constraints.

← Object tags operations · All schemas

Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional refinement criterion that can be one of several predefined schemas, used to combine multiple conditions for event filtering.
coalescingRefineBy (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (anyOf 4)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (anyOf 5)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (anyOf 6)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (anyOf 7)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (anyOf 8)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (anyOf 9)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
eventTypeIdstringOptionalA string representing the unique identifier for the type of event being filtered.
filterLinesarrayRequired within parentAn array of filter metadata objects, each defining a specific condition or set of conditions to apply to the event data.
filterLines[]ModelEach itemExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item
filterTypestringRequired within parentA string that specifies the type of filter being applied. The default value is 'UNIFIED_EVENTS'.
Known values: UNIFIED_EVENTS
Default: UNIFIED_EVENTS
pruningRefineByJSONOptionalAn optional refinement criterion that can be one of several predefined schemas, used to narrow down the events based on specific conditions.
pruningRefineBy (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (anyOf 4)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (anyOf 5)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (anyOf 6)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (anyOf 7)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (anyOf 8)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (anyOf 9)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

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

FieldTypePresenceDescription and constraints
$objectRoot
operationJSONRequired within parentAn object that defines the operation to be performed on the property. The specific structure of this object can vary based on the type of operation being applied.
operation (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL
operation (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
operation (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
operation (anyOf 4)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
operation (anyOf 5)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
operation (anyOf 6)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
operation (anyOf 7)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
operation (anyOf 8)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
operation (anyOf 9)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
operation (anyOf 10)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
operation (anyOf 11)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY
operation (anyOf 12)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
operation (anyOf 13)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
operation (anyOf 14)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
operation (anyOf 15)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
operation (anyOf 16)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
operation (anyOf 17)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
operation (anyOf 18)ModelAlternativeExpand Create tag — response body — filterBranch / 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 property name associated with the event filter.

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

Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: WEBINAR

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

Create tag — response body — filterBranch / filterBranchType: RESTRICTED

FieldTypePresenceDescription and constraints
$objectRoot
filterBranchOperatorstringRequired within parentA string representing the operator used within this filter branch.
filterBranchTypestringRequired within parentA string indicating the type of filter branch, which defaults to 'RESTRICTED'.
Known values: RESTRICTED
Default: RESTRICTED
filterBranchesarrayRequired within parentAn array of nested filter branches, each of which can be of various types such as 'OR', 'AND', 'NOT_ALL', etc.
filterBranches[]JSONEach item
filterBranches[] (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR
filterBranches[] (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: AND
filterBranches[] (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: NOT ALL
filterBranches[] (anyOf 4)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: NOT ANY
filterBranches[] (anyOf 5)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: RESTRICTED
filterBranches[] (anyOf 6)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (anyOf 7)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters applied within this branch, which can include various filter types like property filters, event filters, and more.
filters[]JSONEach item
filters[] (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (anyOf 4)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (anyOf 5)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (anyOf 6)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (anyOf 7)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
filters[] (anyOf 8)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (anyOf 9)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (anyOf 10)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (anyOf 11)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (anyOf 12)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (anyOf 13)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (anyOf 14)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (anyOf 15)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (anyOf 16)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (anyOf 17)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (anyOf 18)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (anyOf 19)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (anyOf 20)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CONSTANT

Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Create tag — response body — filterBranch / filterBranchType: AND, Create tag — response body — filterBranch / filterBranchType: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CTA, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Create tag — response body — filterBranch / filterBranchType: NOT ALL, Create tag — response body — filterBranch / filterBranchType: NOT ANY, Create tag — response body — filterBranch / filterBranchType: OR, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Create tag — response body — filterBranch / filterBranchType: RESTRICTED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: WEBINAR

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional refinement criterion that can be one of several types, such as 'NUM_OCCURRENCES', 'SET_OCCURRENCES', 'RELATIVE_COMPARATIVE', and others, used to further refine the filter logic.
coalescingRefineBy (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (anyOf 4)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (anyOf 5)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (anyOf 6)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (anyOf 7)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (anyOf 8)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (anyOf 9)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
eventTypeIdstringRequired within parentA string representing the unique identifier of the event type to which the filters apply.
filterBranchOperatorstringRequired within parentA string representing the operator used within the filter branch, allowing for logical operations between filters.
filterBranchTypestringRequired within parentA string indicating the type of filter branch, defaulting to 'UNIFIED_EVENTS'.
Known values: UNIFIED_EVENTS
Default: UNIFIED_EVENTS
filterBranchesarrayRequired within parentAn array of nested filter branches, each of which can be one of several types, such as 'OR', 'AND', 'NOT_ALL', 'NOT_ANY', 'RESTRICTED', 'UNIFIED_EVENTS', or 'ASSOCIATION'.
filterBranches[]JSONEach item
filterBranches[] (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR
filterBranches[] (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: AND
filterBranches[] (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: NOT ALL
filterBranches[] (anyOf 4)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: NOT ANY
filterBranches[] (anyOf 5)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: RESTRICTED
filterBranches[] (anyOf 6)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (anyOf 7)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters that can include various types such as property filters, association filters, and others, allowing for detailed and specific filtering criteria.
filters[]JSONEach item
filters[] (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (anyOf 4)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (anyOf 5)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (anyOf 6)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (anyOf 7)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
filters[] (anyOf 8)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (anyOf 9)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (anyOf 10)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (anyOf 11)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (anyOf 12)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (anyOf 13)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (anyOf 14)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (anyOf 15)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (anyOf 16)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (anyOf 17)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (anyOf 18)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (anyOf 19)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (anyOf 20)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CONSTANT
operatorstringRequired within parentA string specifying the operation to be performed, with valid values including 'HAS_COMPLETED' and 'HAS_NOT_COMPLETED'.
Known values: HAS_COMPLETED, HAS_NOT_COMPLETED
pruningRefineByJSONOptionalAn optional refinement criterion similar to coalescingRefineBy, used to prune or limit the filter results based on additional criteria.
pruningRefineBy (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (anyOf 4)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (anyOf 5)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (anyOf 6)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (anyOf 7)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (anyOf 8)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (anyOf 9)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

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

Create tag — response body — filterBranch / 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.
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set.
operationTypestringRequired within parentA string indicating the type of operation, which is 'TIME_POINT' by default.
Known values: TIME_POINT
Default: TIME_POINT
operatorstringRequired within parentA string representing the operator used in the operation.
propertyParserstringOptionalA string indicating the parser used for the property.
timePointJSONRequired within parentAn object representing the specific time point, which can be a date point, indexed time point, or property-referenced time.
timePoint (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 indicating the type of the operation.

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

Create tag — response body — filterBranch / 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 reference used.
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 of the timezone.

Create tag — response body — filterBranch / 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 parentAn object that defines the reference point for the indexed time. It can be one of several types such as 'NOW', 'TODAY', 'WEEK', 'FISCAL_QUARTER', 'FISCAL_YEAR', 'YEAR', 'QUARTER', or 'MONTH'.
indexReference (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 Create tag — response body — filterBranch / 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 indicating the type of time point, which is 'INDEXED' for this component.
Known values: INDEXED
Default: INDEXED
timezoneSourcestringOptionalA string specifying the source of the timezone information.
zoneIdstringRequired within parentA string representing the identifier for the time zone.

Referenced models: Create tag — response body — filterBranch / 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, Create tag — response body — filterBranch / 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, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED offset, Create tag — response body — filterBranch / 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, Create tag — response body — filterBranch / 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, Create tag — response body — filterBranch / 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, Create tag — response body — filterBranch / 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, Create tag — response body — filterBranch / 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, Create tag — response body — filterBranch / 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

Create tag — response body — filterBranch / 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 indicating the day of the week. Valid values include 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', and '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]+)?$

Create tag — response body — filterBranch / 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.
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 of the second.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the minute of 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 that specifies the type of reference, defaulting to 'FISCAL_QUARTER'.
Known values: FISCAL_QUARTER
Default: FISCAL_QUARTER
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the second of the minute.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create tag — response body — filterBranch / 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 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 fiscal year.
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_YEAR' for this component.
Known values: FISCAL_YEAR
Default: FISCAL_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]+)?$

Create tag — response body — filterBranch / 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 defaults to 'MONTH'.
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]+)?$

Create tag — response body — filterBranch / 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 current hour.
Format: int32
hour (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
millisecondJSONOptional
millisecond (anyOf 1)integerAlternativeAn integer representing the current millisecond.
Format: int32
millisecond (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minuteJSONOptional
minute (anyOf 1)integerAlternativeAn integer representing the current minute.
Format: int32
minute (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referenceTypestringRequired within parentA string indicating the type of reference, which is always 'NOW'.
Known values: NOW
Default: NOW
secondJSONOptional
second (anyOf 1)integerAlternativeAn integer representing the current second.
Format: int32
second (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create tag — response body — filterBranch / 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' by default.
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]+)?$

Create tag — response body — filterBranch / 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 always 'TODAY' for this component.
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]+)?$

Create tag — response body — filterBranch / 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 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, which is 'YEAR' by default.
Known values: YEAR
Default: 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]+)?$

Create tag — response body — filterBranch / 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 in the time 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 in the time 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 in the time 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 in the time 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 in the time 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 in the time 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 in the time 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 in the time 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 in the time offset.
Format: int32
years (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED

FieldTypePresenceDescription and constraints
$objectRoot
propertystringRequired within parentA string indicating the property within the CRM object that is being referenced for time operations.
referenceTypestringRequired within parentA string defining the type of reference being used.
timeTypestringRequired within parentA string indicating the type of time reference, which is 'PROPERTY_REFERENCED' by default.
Known values: PROPERTY_REFERENCED
Default: PROPERTY_REFERENCED
timezoneSourcestringOptionalA string specifying the source of the timezone information.
zoneIdstringRequired within parentA string representing the identifier for the timezone.

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE

FieldTypePresenceDescription and constraints
$objectRoot
comparisonstringRequired within parentA string representing the comparison operation to be performed.
timestampJSONRequired within parent
timestamp (anyOf 1)integerAlternativeAn integer representing the specific timestamp for comparison, formatted as an int64.
Format: int64
timestamp (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringRequired within parentA string indicating the type of refinement, which is 'ABSOLUTE_COMPARATIVE' by default.
Known values: ABSOLUTE_COMPARATIVE
Default: ABSOLUTE_COMPARATIVE

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED

FieldTypePresenceDescription and constraints
$objectRoot
lowerTimestampJSONRequired within parent
lowerTimestamp (anyOf 1)integerAlternativeAn integer representing the lower boundary of the timestamp range, specified in Unix time format.
Format: int64
lowerTimestamp (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rangeTypestringRequired within parentA string that specifies the type of range being used.
typestringRequired within parentA string indicating the type of refine by operation. The default value is 'ABSOLUTE_RANGED'.
Known values: ABSOLUTE_RANGED
Default: ABSOLUTE_RANGED
upperTimestampJSONRequired within parent
upperTimestamp (anyOf 1)integerAlternativeAn integer representing the upper boundary of the timestamp range, specified in Unix time format.
Format: int64
upperTimestamp (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY

FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentA string that specifies the type of refinement. The default and only valid value is 'ALL_HISTORY'.
Known values: ALL_HISTORY
Default: ALL_HISTORY

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES

FieldTypePresenceDescription and constraints
$objectRoot
maxOccurrencesJSONOptional
maxOccurrences (anyOf 1)integerAlternativeAn integer representing the maximum number of occurrences allowed for the refinement.
Format: int32
maxOccurrences (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minOccurrencesJSONOptional
minOccurrences (anyOf 1)integerAlternativeAn integer representing the minimum number of occurrences required for the refinement.
Format: int32
minOccurrences (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringRequired within parentA string that specifies the type of refinement. The default value is 'NUM_OCCURRENCES'.
Known values: NUM_OCCURRENCES
Default: NUM_OCCURRENCES

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE

FieldTypePresenceDescription and constraints
$objectRoot
comparisonstringRequired within parentA string that specifies the type of comparison to be made with the timestamp.
timeOffsetModelRequired within parentExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset
typestringRequired within parentA string that indicates the type of refinement, which is 'RELATIVE_COMPARATIVE' by default.
Known values: RELATIVE_COMPARATIVE
Default: RELATIVE_COMPARATIVE

Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAn integer specifying the magnitude of the time offset in the specified time unit.
Format: int64
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetDirectionstringRequired within parentA string indicating the direction of the time offset. Valid values are 'BEFORE' and 'AFTER'.
timeUnitstringRequired within parentA string representing the unit of time for the offset, such as 'DAYS', 'HOURS', 'MINUTES', etc.

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED

FieldTypePresenceDescription and constraints
$objectRoot
lowerBoundOffsetModelRequired within parentExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset
rangeTypestringRequired within parentA string that defines the type of range for the timestamp refinement.
typestringRequired within parentA string that specifies the type of refine operation. The default value is 'RELATIVE_RANGED'.
Known values: RELATIVE_RANGED
Default: RELATIVE_RANGED
upperBoundOffsetModelRequired within parentExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset

Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES

FieldTypePresenceDescription and constraints
$objectRoot
setTypestringRequired within parentA string representing the specific set type used for refining occurrences.
typestringRequired within parentA string that specifies the type of refinement. The default value is 'SET_OCCURRENCES'.
Known values: SET_OCCURRENCES
Default: SET_OCCURRENCES

Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

FieldTypePresenceDescription and constraints
$objectRoot
includeObjectsWithNoValueSetbooleanRequired within parentA boolean indicating whether to include objects that have no value set for the specified property.
lowerBoundEndpointBehaviorstringOptionalA string specifying the behavior at the lower endpoint of the time range.
lowerBoundTimePointJSONRequired within parentDefines the lower bound of the time range, which can be a date point, indexed time point, or property-referenced time.
lowerBoundTimePoint (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE
lowerBoundTimePoint (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED
lowerBoundTimePoint (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED
operationTypestringRequired within parentA string representing the type of operation being performed.
operatorstringRequired within parentA string representing the operator used in the time-ranged operation.
propertyParserstringOptionalA string indicating the parser used for the property in the operation.
typestringRequired within parentA string indicating the type of operation, defaulting to 'TIME_RANGED'.
Known values: TIME_RANGED
Default: TIME_RANGED
upperBoundEndpointBehaviorstringOptionalA string specifying the behavior at the upper endpoint of the time range.
upperBoundTimePointJSONRequired within parentDefines the upper bound of the time range, which can be a date point, indexed time point, or property-referenced time.
upperBoundTimePoint (anyOf 1)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE
upperBoundTimePoint (anyOf 2)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED
upperBoundTimePoint (anyOf 3)ModelAlternativeExpand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED

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

Retrieve tags — response body

FieldTypePresenceDescription and constraints
$objectRoot
resultsarrayRequired within parentAn array of CRM object tags. Each item in the array is a PublicCrmObjectTag object.
results[]ModelEach itemExpand Create tag — response body

Referenced models: Create tag — response body

Update tag (Partial) — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
colorobjectRequired within parentAn object representing the new color for the CRM object tag.
descriptionobjectRequired within parentAn object representing the new description for the CRM object tag.
filterBranchobjectRequired within parentAn object representing the new filter branch for the CRM object tag.
filterPipelineIdsobjectRequired within parentAn object representing the new set of pipeline IDs associated with the CRM object tag.
nameobjectRequired within parentAn object representing the new name for the CRM object tag.

Update tag (Replace) — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
colorstringRequired within parentA string specifying the color associated with the CRM object tag.
descriptionstringOptionalA string providing a description of the CRM object tag.
filterBranchJSONRequired within parentAn object that defines the filter branch for the CRM object tag. It can be one of several filter branch types, such as PublicOrFilterBranch or PublicAndFilterBranch.
filterBranch (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR
filterBranch (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: AND
filterBranch (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL
filterBranch (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY
filterBranch (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED
filterBranch (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranch (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION
filterPipelineIdsarrayRequired within parentAn array of strings representing the IDs of the pipelines to which the CRM object tag is applicable.
filterPipelineIds[]stringEach item
namestringRequired within parentA string representing the name of the CRM object tag.

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: AND, Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION, Create tag — request body — body / filterBranch / filterBranchType: NOT ALL, Create tag — request body — body / filterBranch / filterBranchType: NOT ANY, Create tag — request body — body / filterBranch / filterBranchType: OR, Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED

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.