Skip to content

HubSpot: Object tags schemas (part 1)

24 HubSpot schemas with complete fields and constraints.

← Object tags operations · All schemas

Create tag — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
colorstringRequired within parentThe color associated with the CRM object tag. It is a string value.
descriptionstringOptionalA string providing additional information about the CRM object tag.
displayOrderintegerRequired within parentAn integer indicating the order in which the tag should be displayed.
Format: int32
filterBranchJSONRequired within parentDefines the filter criteria for the CRM object tag. It can be one of several filter branch types.
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 tag applies.
filterPipelineIds[]stringEach item
namestringRequired within parentThe name of the CRM object tag. It is a string value.

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

Create tag — request body — body / filterBranch / filterBranchType: AND

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. The default value is 'AND'.
Default: AND
One of: AND
filterBranchesarrayRequired within parentAn array of nested filter branches, each of which can be another AND, OR, NOT_ALL, NOT_ANY, RESTRICTED, UNIFIED_EVENTS, or ASSOCIATION filter branch.
filterBranches[]JSONEach item
filterBranches[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR
filterBranches[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: AND
filterBranches[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL
filterBranches[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY
filterBranches[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED
filterBranches[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters that must all be satisfied for this branch to evaluate as true. Each filter can be a property filter, association filter, or other types of analytics and event filters.
filters[]JSONEach item
filters[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (oneOf 10)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (oneOf 11)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (oneOf 12)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (oneOf 13)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (oneOf 14)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (oneOf 15)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (oneOf 16)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (oneOf 17)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (oneOf 18)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (oneOf 19)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (oneOf 20)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT

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

Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION

FieldTypePresenceDescription and constraints
$objectRoot
associationCategorystringRequired within parentA string indicating the category of the association.
associationTypeIdintegerRequired within parentAn integer representing the unique identifier for the type of association.
Format: int32
filterBranchOperatorstringRequired within parentA string representing the operator applied to the filter branch.
filterBranchTypestringRequired within parentA string indicating the type of filter branch. Defaults to 'ASSOCIATION'.
Default: ASSOCIATION
One of: ASSOCIATION
filterBranchesarrayRequired within parentAn array of filter branches, each of which can be one of several types, including OR, AND, NOT_ALL, NOT_ANY, RESTRICTED, UNIFIED_EVENTS, or ASSOCIATION.
filterBranches[]JSONEach item
filterBranches[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR
filterBranches[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: AND
filterBranches[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL
filterBranches[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY
filterBranches[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED
filterBranches[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters that can include various types such as property filters, association filters, and analytics filters.
filters[]JSONEach item
filters[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (oneOf 10)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (oneOf 11)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (oneOf 12)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (oneOf 13)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (oneOf 14)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (oneOf 15)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (oneOf 16)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (oneOf 17)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (oneOf 18)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (oneOf 19)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (oneOf 20)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT
objectTypeIdstringRequired within parentA string representing the unique identifier for the object type being filtered.
operatorstringRequired within parentA string representing the operator used in the filter branch.

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

Create tag — request body — body / filterBranch / filterBranchType: NOT ALL

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. The default value is 'NOT_ALL'.
Default: NOT_ALL
One of: NOT_ALL
filterBranchesarrayRequired within parentAn array of nested filter branches, allowing for complex filter structures. Each item can be one of several filter branch types.
filterBranches[]JSONEach item
filterBranches[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR
filterBranches[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: AND
filterBranches[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL
filterBranches[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY
filterBranches[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED
filterBranches[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters applied within this branch. Each filter can be one of several types, such as property filters or event analytics filters.
filters[]JSONEach item
filters[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (oneOf 10)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (oneOf 11)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (oneOf 12)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (oneOf 13)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (oneOf 14)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (oneOf 15)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (oneOf 16)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (oneOf 17)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (oneOf 18)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (oneOf 19)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (oneOf 20)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT

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

Create tag — request body — body / filterBranch / filterBranchType: NOT ANY

FieldTypePresenceDescription and constraints
$objectRoot
filterBranchOperatorstringRequired within parentA string representing the operator used in the filter branch.
filterBranchTypestringRequired within parentA string indicating the type of filter branch. The default value is 'NOT_ANY'.
Default: NOT_ANY
One of: NOT_ANY
filterBranchesarrayRequired within parentAn array of nested filter branches. Each item can be one of several types of filter branches, such as 'PublicOrFilterBranch', 'PublicAndFilterBranch', or 'PublicNotAnyFilterBranch'.
filterBranches[]JSONEach item
filterBranches[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR
filterBranches[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: AND
filterBranches[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL
filterBranches[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY
filterBranches[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED
filterBranches[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters applied within this branch. Each filter can be one of various types, such as 'PublicPropertyFilter', 'PublicEventAnalyticsFilter', or 'PublicEmailEventFilter'.
filters[]JSONEach item
filters[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (oneOf 10)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (oneOf 11)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (oneOf 12)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (oneOf 13)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (oneOf 14)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (oneOf 15)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (oneOf 16)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (oneOf 17)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (oneOf 18)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (oneOf 19)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (oneOf 20)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT

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

Create tag — request body — body / filterBranch / filterBranchType: OR

FieldTypePresenceDescription and constraints
$objectRoot
filterBranchOperatorstringRequired within parentA string that represents the operator used within the filter branch.
filterBranchTypestringRequired within parentA string that specifies the type of filter branch. The default value is 'OR'.
Default: OR
One of: OR
filterBranchesarrayRequired within parentAn array of filter branches that can include various types such as 'PublicOrFilterBranch', 'PublicAndFilterBranch', 'PublicNotAllFilterBranch', and others.
filterBranches[]JSONEach item
filterBranches[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR
filterBranches[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: AND
filterBranches[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL
filterBranches[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY
filterBranches[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED
filterBranches[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
filterBranches[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION
filtersarrayRequired within parentAn array of filters that can include different types such as 'PublicPropertyFilter', 'PublicAssociationInListFilter', 'PublicPageViewAnalyticsFilter', and others.
filters[]JSONEach item
filters[] (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY
filters[] (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
filters[] (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
filters[] (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA
filters[] (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT
filters[] (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
filters[] (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
filters[] (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION
filters[] (oneOf 10)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION
filters[] (oneOf 11)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
filters[] (oneOf 12)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
filters[] (oneOf 13)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
filters[] (oneOf 14)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT
filters[] (oneOf 15)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY
filters[] (oneOf 16)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH
filters[] (oneOf 17)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME
filters[] (oneOf 18)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST
filters[] (oneOf 19)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
filters[] (oneOf 20)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT

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

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH

FieldTypePresenceDescription and constraints
$objectRoot
adNetworkstringRequired within parentA string that specifies the ad network where the search is being conducted.
entityTypestringRequired within parentA string that represents the type of entity being searched for in the ads.
filterTypestringRequired within parentA string that specifies the type of filter being applied. The default value is 'ADS_SEARCH'.
Default: ADS_SEARCH
One of: ADS_SEARCH
operatorstringRequired within parentA string that defines the operation or condition applied to the search terms.
searchTermTypestringRequired within parentA string that indicates the type of search term being used in the filter.
searchTermsarrayRequired within parentAn array of strings containing the search terms used to filter the ads.
searchTerms[]stringEach item

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string that specifies the type of filter being applied. The default value is 'ADS_TIME'.
Default: ADS_TIME
One of: ADS_TIME
pruningRefineByJSONRequired within parentAn object that defines the criteria for refining the pruning of the filter. It can be one of several types, such as PublicNumOccurrencesRefineBy, PublicSetOccurrencesRefineBy, or various timestamp refine types.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION

FieldTypePresenceDescription and constraints
$objectRoot
associationCategorystringRequired within parentA string indicating the category of the association.
associationTypeIdintegerRequired within parentAn integer representing the unique identifier for the type of association.
Format: int32
coalescingRefineByJSONRequired within parentAn object used to refine the filter by combining multiple criteria. It can be one of several predefined schemas such as PublicNumOccurrencesRefineBy or PublicTimePointOperation.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
filterTypestringRequired within parentA string indicating the type of filter. Defaults to 'ASSOCIATION'.
Default: ASSOCIATION
One of: ASSOCIATION
listIdstringRequired within parentA string representing the unique identifier of the list to filter.
operatorstringRequired within parentA string representing the operator used in the filter.
toObjectTypestringOptionalA string representing the type of object that the association points to.
toObjectTypeIdstringOptionalA string representing the type ID of the object that the association points to.

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION

FieldTypePresenceDescription and constraints
$objectRoot
acceptedOptStatesarrayRequired within parentAn array of strings representing the opt-in states that are accepted for the filter.
acceptedOptStates[]stringEach item
businessUnitIdstringOptionalA string representing the ID of the business unit associated with the subscription.
channelstringRequired within parentA string indicating the communication channel associated with the subscription.
filterTypestringRequired within parentA string that specifies the type of filter. Default value is 'COMMUNICATION_SUBSCRIPTION'.
Default: COMMUNICATION_SUBSCRIPTION
One of: COMMUNICATION_SUBSCRIPTION
subscriptionIdsarrayRequired within parentAn array of strings representing the IDs of the subscriptions to be filtered.
subscriptionIds[]stringEach item
subscriptionTypestringRequired within parentA string indicating the type of subscription being filtered.

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string representing the type of filter. The default value is 'CONSTANT'.
Default: CONSTANT
One of: CONSTANT
shouldAcceptbooleanRequired within parentA boolean indicating whether the filter should accept the criteria. If true, the criteria are accepted; if false, they are rejected.
sourcestringOptionalA string providing the source of the filter. This property is optional.

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional parameter that allows further refinement of the filter by combining multiple conditions. It can be one of several predefined schemas such as PublicNumOccurrencesRefineBy or PublicTimePointOperation.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
ctaNamestringRequired within parentA string representing the name of the Call-to-Action (CTA) to be filtered.
filterTypestringRequired within parentA string that specifies the type of filter being used. The default value is 'CTA'.
Default: CTA
One of: CTA
operatorstringRequired within parentA string that defines the operation to be performed by the filter.
pruningRefineByJSONOptionalAn optional parameter that allows further refinement of the filter by excluding certain conditions. It can be one of several predefined schemas such as PublicNumOccurrencesRefineBy or PublicTimePointOperation.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT

FieldTypePresenceDescription and constraints
$objectRoot
appIdstringRequired within parentA string that uniquely identifies the application associated with the email event.
clickUrlstringOptionalA string representing the URL that was clicked in the email event.
emailIdstringRequired within parentA string that uniquely identifies the email associated with the event.
filterTypestringRequired within parentA string indicating the type of filter. The default value is 'EMAIL_EVENT'.
Default: EMAIL_EVENT
One of: EMAIL_EVENT
levelstringRequired within parentA string representing the level of the email event.
operatorstringRequired within parentA string representing the operation type for the filter. Valid values include 'LINK_CLICKED', 'MARKED_SPAM', 'OPENED', 'OPENED_BUT_LINK_NOT_CLICKED', 'OPENED_BUT_NOT_REPLIED', 'REPLIED', 'UNSUBSCRIBED', 'BOUNCED', 'RECEIVED', 'RECEIVED_BUT_NOT_OPENED', 'SENT', 'SENT_BUT_LINK_NOT_CLICKED', and 'SENT_BUT_NOT_RECEIVED'.
One of: BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED
pruningRefineByJSONOptionalAn object that allows further refinement of the filter based on various criteria such as occurrences or time points.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION

FieldTypePresenceDescription and constraints
$objectRoot
acceptedStatusesarrayRequired within parentAn array of strings indicating the subscription statuses that are accepted in the filter.
acceptedStatuses[]stringEach item
filterTypestringRequired within parentA string indicating the type of filter, which is 'EMAIL_SUBSCRIPTION' for this component.
Default: EMAIL_SUBSCRIPTION
One of: EMAIL_SUBSCRIPTION
subscriptionIdsarrayRequired within parentAn array of strings representing the IDs of the subscriptions to be filtered.
subscriptionIds[]stringEach item
subscriptionTypestringOptionalA string representing the type of subscription, which may be used to further refine the filter.

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional refinement criterion that can be one of several types, such as occurrences or timestamp-based refinements.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
eventIdstringRequired within parentA string representing the unique identifier for the event being filtered.
filterTypestringRequired within parentA string indicating the type of filter. The default value is 'EVENT'.
Default: EVENT
One of: EVENT
operatorstringRequired within parentA string representing the operator used in the filter.
pruningRefineByJSONOptionalAn optional refinement criterion used to narrow down the filter results, similar to coalescingRefineBy, with options like occurrences or timestamp-based refinements.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional refinement criterion that can be one of several types, such as occurrences or timestamp-based refinements.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
filterTypestringRequired within parentA string that specifies the type of filter. The default value is 'FORM_SUBMISSION_ON_PAGE'.
Default: FORM_SUBMISSION_ON_PAGE
One of: FORM_SUBMISSION_ON_PAGE
formIdstringOptionalA string representing the unique identifier of the form.
operatorstringRequired within parentA string that determines the operation to be applied. Valid values include 'FILLED_OUT' and 'NOT_FILLED_OUT'.
One of: FILLED_OUT, NOT_FILLED_OUT
pageIdstringRequired within parentA string representing the unique identifier of the page.
pruningRefineByJSONOptionalAn optional refinement criterion that can be one of several types, such as occurrences or timestamp-based refinements.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn object used to refine the filter by combining multiple criteria, such as occurrences or timestamps.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
filterTypestringRequired within parentA string that specifies the type of filter. The default value is 'FORM_SUBMISSION'.
Default: FORM_SUBMISSION
One of: FORM_SUBMISSION
formIdstringOptionalA string representing the unique identifier of the form.
operatorstringRequired within parentA string that determines the operation to be performed. Valid values include 'FILLED_OUT' and 'NOT_FILLED_OUT'.
One of: FILLED_OUT, NOT_FILLED_OUT
pruningRefineByJSONOptionalAn object used to refine the filter by specific criteria, such as occurrences or timestamps.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string that specifies the type of filter. The default value is 'IN_LIST'.
Default: IN_LIST
One of: IN_LIST
listIdstringRequired within parentA string representing the unique identifier of the list to filter against.
metadataModelOptionalExpand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata
operatorstringRequired within parentA string representing the operator used in the filter.

Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT

FieldTypePresenceDescription and constraints
$objectRoot
eventTypeIdintegerRequired within parentA string representing the unique identifier of the event type being filtered.
Format: int32
filterLinesarrayRequired within parentAn array of filter metadata objects that define the specific conditions or criteria for the event filter. Each item in the array is a reference to a PublicEventFilterMetadata schema.
filterLines[]ModelEach itemExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item
filterTypestringRequired within parentA string that indicates the type of filter being applied. This property has a default value of 'INTEGRATION_EVENT'.
Default: INTEGRATION_EVENT
One of: INTEGRATION_EVENT

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW

FieldTypePresenceDescription and constraints
$objectRoot
coalescingRefineByJSONOptionalAn optional refinement criterion used to coalesce data. It can be one of several predefined schemas, such as PublicNumOccurrencesRefineBy or PublicTimePointOperation.
coalescingRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
coalescingRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
coalescingRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
coalescingRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
coalescingRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
coalescingRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
coalescingRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
coalescingRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
coalescingRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
enableTrackingbooleanOptionalA boolean indicating whether tracking is enabled for the page view analytics.
filterTypestringRequired within parentA string that specifies the type of filter being applied. For this component, it defaults to 'PAGE_VIEW'.
Default: PAGE_VIEW
One of: PAGE_VIEW
operatorstringRequired within parentA string representing the operator used in the filter. This determines how the filter criteria are applied.
pageUrlstringRequired within parentA string representing the URL of the page for which analytics data is being filtered.
pruningRefineByJSONOptionalAn optional refinement criterion used to prune data. Similar to coalescingRefineBy, it can be one of several predefined schemas.
pruningRefineBy (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
pruningRefineBy (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
pruningRefineBy (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
pruningRefineBy (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
pruningRefineBy (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
pruningRefineBy (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
pruningRefineBy (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
pruningRefineBy (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
pruningRefineBy (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT

Create tag — request body — body / filterBranch / 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. It is a constant value used to identify the filter type.
Default: PRIVACY
One of: PRIVACY
operatorstringRequired within parentA string specifying the operation or condition to be applied in the filter. The exact operations are not detailed in the specification.
privacyNamestringRequired within parentA string representing the name of the privacy setting or preference that the filter will apply to.

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY

FieldTypePresenceDescription and constraints
$objectRoot
filterTypestringRequired within parentA string indicating the type of filter, which is 'PROPERTY' by default.
Default: PROPERTY
One of: PROPERTY
operationJSONRequired within parentDefines the operation to be performed on the property for filtering. This can be one of several operation types, such as boolean, number, string, date, and more, depending on the schema referenced.
operation (oneOf 1)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL
operation (oneOf 2)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
operation (oneOf 3)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
operation (oneOf 4)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
operation (oneOf 5)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
operation (oneOf 6)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
operation (oneOf 7)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
operation (oneOf 8)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
operation (oneOf 9)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
operation (oneOf 10)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
operation (oneOf 11)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY
operation (oneOf 12)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
operation (oneOf 13)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
operation (oneOf 14)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
operation (oneOf 15)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
operation (oneOf 16)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
operation (oneOf 17)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
operation (oneOf 18)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING
operation (oneOf 19)ModelAlternativeExpand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
propertystringRequired within parentThe name of the property to filter by, represented as a string.

Referenced models: Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER

Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY

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. It is expected to be 'ALL_PROPERTY_TYPES'.
Default: ALL_PROPERTY
One of: ALL_PROPERTY
operatorstringRequired within parentA string representing the operator used in the operation.

Create tag — request body — body / filterBranch / 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 for the property should be included in the operation.
operationTypestringRequired within parentA string indicating the type of operation. The default value is 'BOOLEAN'.
Default: BOOL
One of: BOOL
operatorstringRequired within parentA string representing the operator used in the boolean operation.
valuebooleanRequired within parentA boolean representing the value to be used in the operation.

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.