← Object tags operations · All schemas
Create tag — request body — body
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
filterBranchOperator | string | Required within parent | A string representing the operator used within this filter branch. |
filterBranchType | string | Required within parent | A string indicating the type of filter branch. The default value is 'AND'. Default: AND One of: AND |
filterBranches | array | Required within parent | An 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[] | JSON | Each item | |
filterBranches[] (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR |
filterBranches[] (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: AND |
filterBranches[] (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL |
filterBranches[] (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY |
filterBranches[] (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED |
filterBranches[] (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED |
filterBranches[] (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION |
filters | array | Required within parent | An 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[] | JSON | Each item | |
filters[] (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY |
filters[] (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION |
filters[] (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW |
filters[] (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA |
filters[] (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT |
filters[] (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT |
filters[] (oneOf 7) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT |
filters[] (oneOf 9) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION |
filters[] (oneOf 10) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION |
filters[] (oneOf 11) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY |
filters[] (oneOf 12) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE |
filters[] (oneOf 13) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR |
filters[] (oneOf 14) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT |
filters[] (oneOf 15) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY |
filters[] (oneOf 16) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH |
filters[] (oneOf 17) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME |
filters[] (oneOf 18) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST |
filters[] (oneOf 19) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS |
filters[] (oneOf 20) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
associationCategory | string | Required within parent | A string indicating the category of the association. |
associationTypeId | integer | Required within parent | An integer representing the unique identifier for the type of association. Format: int32 |
filterBranchOperator | string | Required within parent | A string representing the operator applied to the filter branch. |
filterBranchType | string | Required within parent | A string indicating the type of filter branch. Defaults to 'ASSOCIATION'. Default: ASSOCIATION One of: ASSOCIATION |
filterBranches | array | Required within parent | An 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[] | JSON | Each item | |
filterBranches[] (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR |
filterBranches[] (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: AND |
filterBranches[] (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL |
filterBranches[] (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY |
filterBranches[] (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED |
filterBranches[] (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED |
filterBranches[] (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION |
filters | array | Required within parent | An array of filters that can include various types such as property filters, association filters, and analytics filters. |
filters[] | JSON | Each item | |
filters[] (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY |
filters[] (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION |
filters[] (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW |
filters[] (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA |
filters[] (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT |
filters[] (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT |
filters[] (oneOf 7) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT |
filters[] (oneOf 9) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION |
filters[] (oneOf 10) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION |
filters[] (oneOf 11) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY |
filters[] (oneOf 12) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE |
filters[] (oneOf 13) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR |
filters[] (oneOf 14) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT |
filters[] (oneOf 15) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY |
filters[] (oneOf 16) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH |
filters[] (oneOf 17) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME |
filters[] (oneOf 18) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST |
filters[] (oneOf 19) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS |
filters[] (oneOf 20) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT |
objectTypeId | string | Required within parent | A string representing the unique identifier for the object type being filtered. |
operator | string | Required within parent | A 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
filterBranchOperator | string | Required within parent | A string representing the operator used in the filter branch. |
filterBranchType | string | Required within parent | A string indicating the type of filter branch. The default value is 'NOT_ANY'. Default: NOT_ANY One of: NOT_ANY |
filterBranches | array | Required within parent | An array of nested filter branches. Each item can be one of several types of filter branches, such as 'PublicOrFilterBranch', 'PublicAndFilterBranch', or 'PublicNotAnyFilterBranch'. |
filterBranches[] | JSON | Each item | |
filterBranches[] (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR |
filterBranches[] (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: AND |
filterBranches[] (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL |
filterBranches[] (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY |
filterBranches[] (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED |
filterBranches[] (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED |
filterBranches[] (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION |
filters | array | Required within parent | An array of filters applied within this branch. Each filter can be one of various types, such as 'PublicPropertyFilter', 'PublicEventAnalyticsFilter', or 'PublicEmailEventFilter'. |
filters[] | JSON | Each item | |
filters[] (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY |
filters[] (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION |
filters[] (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW |
filters[] (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA |
filters[] (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT |
filters[] (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT |
filters[] (oneOf 7) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT |
filters[] (oneOf 9) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION |
filters[] (oneOf 10) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION |
filters[] (oneOf 11) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY |
filters[] (oneOf 12) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE |
filters[] (oneOf 13) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR |
filters[] (oneOf 14) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT |
filters[] (oneOf 15) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY |
filters[] (oneOf 16) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH |
filters[] (oneOf 17) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME |
filters[] (oneOf 18) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST |
filters[] (oneOf 19) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS |
filters[] (oneOf 20) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
filterBranchOperator | string | Required within parent | A string that represents the operator used within the filter branch. |
filterBranchType | string | Required within parent | A string that specifies the type of filter branch. The default value is 'OR'. Default: OR One of: OR |
filterBranches | array | Required within parent | An array of filter branches that can include various types such as 'PublicOrFilterBranch', 'PublicAndFilterBranch', 'PublicNotAllFilterBranch', and others. |
filterBranches[] | JSON | Each item | |
filterBranches[] (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR |
filterBranches[] (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: AND |
filterBranches[] (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL |
filterBranches[] (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY |
filterBranches[] (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED |
filterBranches[] (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED |
filterBranches[] (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION |
filters | array | Required within parent | An array of filters that can include different types such as 'PublicPropertyFilter', 'PublicAssociationInListFilter', 'PublicPageViewAnalyticsFilter', and others. |
filters[] | JSON | Each item | |
filters[] (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY |
filters[] (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION |
filters[] (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW |
filters[] (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA |
filters[] (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT |
filters[] (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT |
filters[] (oneOf 7) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT |
filters[] (oneOf 9) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION |
filters[] (oneOf 10) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION |
filters[] (oneOf 11) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY |
filters[] (oneOf 12) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE |
filters[] (oneOf 13) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR |
filters[] (oneOf 14) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT |
filters[] (oneOf 15) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY |
filters[] (oneOf 16) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH |
filters[] (oneOf 17) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME |
filters[] (oneOf 18) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST |
filters[] (oneOf 19) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS |
filters[] (oneOf 20) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
adNetwork | string | Required within parent | A string that specifies the ad network where the search is being conducted. |
entityType | string | Required within parent | A string that represents the type of entity being searched for in the ads. |
filterType | string | Required within parent | A string that specifies the type of filter being applied. The default value is 'ADS_SEARCH'. Default: ADS_SEARCH One of: ADS_SEARCH |
operator | string | Required within parent | A string that defines the operation or condition applied to the search terms. |
searchTermType | string | Required within parent | A string that indicates the type of search term being used in the filter. |
searchTerms | array | Required within parent | An array of strings containing the search terms used to filter the ads. |
searchTerms[] | string | Each item | |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
filterType | string | Required within parent | A string that specifies the type of filter being applied. The default value is 'ADS_TIME'. Default: ADS_TIME One of: ADS_TIME |
pruningRefineBy | JSON | Required within parent | An 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
pruningRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
pruningRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
pruningRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
pruningRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
pruningRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
pruningRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
pruningRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
associationCategory | string | Required within parent | A string indicating the category of the association. |
associationTypeId | integer | Required within parent | An integer representing the unique identifier for the type of association. Format: int32 |
coalescingRefineBy | JSON | Required within parent | An 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
coalescingRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
coalescingRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
coalescingRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
coalescingRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
coalescingRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
coalescingRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
coalescingRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED |
filterType | string | Required within parent | A string indicating the type of filter. Defaults to 'ASSOCIATION'. Default: ASSOCIATION One of: ASSOCIATION |
listId | string | Required within parent | A string representing the unique identifier of the list to filter. |
operator | string | Required within parent | A string representing the operator used in the filter. |
toObjectType | string | Optional | A string representing the type of object that the association points to. |
toObjectTypeId | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
acceptedOptStates | array | Required within parent | An array of strings representing the opt-in states that are accepted for the filter. |
acceptedOptStates[] | string | Each item | |
businessUnitId | string | Optional | A string representing the ID of the business unit associated with the subscription. |
channel | string | Required within parent | A string indicating the communication channel associated with the subscription. |
filterType | string | Required within parent | A string that specifies the type of filter. Default value is 'COMMUNICATION_SUBSCRIPTION'. Default: COMMUNICATION_SUBSCRIPTION One of: COMMUNICATION_SUBSCRIPTION |
subscriptionIds | array | Required within parent | An array of strings representing the IDs of the subscriptions to be filtered. |
subscriptionIds[] | string | Each item | |
subscriptionType | string | Required within parent | A string indicating the type of subscription being filtered. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
filterType | string | Required within parent | A string representing the type of filter. The default value is 'CONSTANT'. Default: CONSTANT One of: CONSTANT |
shouldAccept | boolean | Required within parent | A boolean indicating whether the filter should accept the criteria. If true, the criteria are accepted; if false, they are rejected. |
source | string | Optional | A string providing the source of the filter. This property is optional. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
coalescingRefineBy | JSON | Optional | An 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
coalescingRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
coalescingRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
coalescingRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
coalescingRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
coalescingRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
coalescingRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
coalescingRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED |
ctaName | string | Required within parent | A string representing the name of the Call-to-Action (CTA) to be filtered. |
filterType | string | Required within parent | A string that specifies the type of filter being used. The default value is 'CTA'. Default: CTA One of: CTA |
operator | string | Required within parent | A string that defines the operation to be performed by the filter. |
pruningRefineBy | JSON | Optional | An 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
pruningRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
pruningRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
pruningRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
pruningRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
pruningRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
pruningRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
pruningRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
appId | string | Required within parent | A string that uniquely identifies the application associated with the email event. |
clickUrl | string | Optional | A string representing the URL that was clicked in the email event. |
emailId | string | Required within parent | A string that uniquely identifies the email associated with the event. |
filterType | string | Required within parent | A string indicating the type of filter. The default value is 'EMAIL_EVENT'. Default: EMAIL_EVENT One of: EMAIL_EVENT |
level | string | Required within parent | A string representing the level of the email event. |
operator | string | Required within parent | A 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 |
pruningRefineBy | JSON | Optional | An object that allows further refinement of the filter based on various criteria such as occurrences or time points. |
pruningRefineBy (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
pruningRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
pruningRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
pruningRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
pruningRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
pruningRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
pruningRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
pruningRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
acceptedStatuses | array | Required within parent | An array of strings indicating the subscription statuses that are accepted in the filter. |
acceptedStatuses[] | string | Each item | |
filterType | string | Required within parent | A string indicating the type of filter, which is 'EMAIL_SUBSCRIPTION' for this component. Default: EMAIL_SUBSCRIPTION One of: EMAIL_SUBSCRIPTION |
subscriptionIds | array | Required within parent | An array of strings representing the IDs of the subscriptions to be filtered. |
subscriptionIds[] | string | Each item | |
subscriptionType | string | Optional | A string representing the type of subscription, which may be used to further refine the filter. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
coalescingRefineBy | JSON | Optional | An optional refinement criterion that can be one of several types, such as occurrences or timestamp-based refinements. |
coalescingRefineBy (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
coalescingRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
coalescingRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
coalescingRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
coalescingRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
coalescingRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
coalescingRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
coalescingRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED |
eventId | string | Required within parent | A string representing the unique identifier for the event being filtered. |
filterType | string | Required within parent | A string indicating the type of filter. The default value is 'EVENT'. Default: EVENT One of: EVENT |
operator | string | Required within parent | A string representing the operator used in the filter. |
pruningRefineBy | JSON | Optional | An optional refinement criterion used to narrow down the filter results, similar to coalescingRefineBy, with options like occurrences or timestamp-based refinements. |
pruningRefineBy (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
pruningRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
pruningRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
pruningRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
pruningRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
pruningRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
pruningRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
pruningRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
coalescingRefineBy | JSON | Optional | An optional refinement criterion that can be one of several types, such as occurrences or timestamp-based refinements. |
coalescingRefineBy (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
coalescingRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
coalescingRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
coalescingRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
coalescingRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
coalescingRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
coalescingRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
coalescingRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED |
filterType | string | Required within parent | A string that specifies the type of filter. The default value is 'FORM_SUBMISSION_ON_PAGE'. Default: FORM_SUBMISSION_ON_PAGE One of: FORM_SUBMISSION_ON_PAGE |
formId | string | Optional | A string representing the unique identifier of the form. |
operator | string | Required within parent | A string that determines the operation to be applied. Valid values include 'FILLED_OUT' and 'NOT_FILLED_OUT'. One of: FILLED_OUT, NOT_FILLED_OUT |
pageId | string | Required within parent | A string representing the unique identifier of the page. |
pruningRefineBy | JSON | Optional | An optional refinement criterion that can be one of several types, such as occurrences or timestamp-based refinements. |
pruningRefineBy (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
pruningRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
pruningRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
pruningRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
pruningRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
pruningRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
pruningRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
pruningRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
coalescingRefineBy | JSON | Optional | An object used to refine the filter by combining multiple criteria, such as occurrences or timestamps. |
coalescingRefineBy (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
coalescingRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
coalescingRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
coalescingRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
coalescingRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
coalescingRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
coalescingRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
coalescingRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED |
filterType | string | Required within parent | A string that specifies the type of filter. The default value is 'FORM_SUBMISSION'. Default: FORM_SUBMISSION One of: FORM_SUBMISSION |
formId | string | Optional | A string representing the unique identifier of the form. |
operator | string | Required within parent | A string that determines the operation to be performed. Valid values include 'FILLED_OUT' and 'NOT_FILLED_OUT'. One of: FILLED_OUT, NOT_FILLED_OUT |
pruningRefineBy | JSON | Optional | An object used to refine the filter by specific criteria, such as occurrences or timestamps. |
pruningRefineBy (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
pruningRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
pruningRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
pruningRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
pruningRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
pruningRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
pruningRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
pruningRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand 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
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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
eventTypeId | integer | Required within parent | A string representing the unique identifier of the event type being filtered. Format: int32 |
filterLines | array | Required within parent | An 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[] | Model | Each item | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item |
filterType | string | Required within parent | A 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
coalescingRefineBy | JSON | Optional | An optional refinement criterion used to coalesce data. It can be one of several predefined schemas, such as PublicNumOccurrencesRefineBy or PublicTimePointOperation. |
coalescingRefineBy (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
coalescingRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
coalescingRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
coalescingRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
coalescingRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
coalescingRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
coalescingRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
coalescingRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED |
enableTracking | boolean | Optional | A boolean indicating whether tracking is enabled for the page view analytics. |
filterType | string | Required within parent | A string that specifies the type of filter being applied. For this component, it defaults to 'PAGE_VIEW'. Default: PAGE_VIEW One of: PAGE_VIEW |
operator | string | Required within parent | A string representing the operator used in the filter. This determines how the filter criteria are applied. |
pageUrl | string | Required within parent | A string representing the URL of the page for which analytics data is being filtered. |
pruningRefineBy | JSON | Optional | An optional refinement criterion used to prune data. Similar to coalescingRefineBy, it can be one of several predefined schemas. |
pruningRefineBy (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
pruningRefineBy (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
pruningRefineBy (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
pruningRefineBy (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
pruningRefineBy (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
pruningRefineBy (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
pruningRefineBy (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
pruningRefineBy (oneOf 8) | Model | Alternative | Expand 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) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
filterType | string | Required within parent | A 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 |
operator | string | Required within parent | A string specifying the operation or condition to be applied in the filter. The exact operations are not detailed in the specification. |
privacyName | string | Required within parent | A 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
filterType | string | Required within parent | A string indicating the type of filter, which is 'PROPERTY' by default. Default: PROPERTY One of: PROPERTY |
operation | JSON | Required within parent | Defines 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL |
operation (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER |
operation (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING |
operation (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME |
operation (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE |
operation (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED |
operation (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE |
operation (oneOf 8) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE |
operation (oneOf 9) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED |
operation (oneOf 10) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION |
operation (oneOf 11) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY |
operation (oneOf 12) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED |
operation (oneOf 13) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING |
operation (oneOf 14) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE |
operation (oneOf 15) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE |
operation (oneOf 16) | Model | Alternative | Expand 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) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED |
operation (oneOf 18) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING |
operation (oneOf 19) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER |
property | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects with no value set should be included in the operation. |
operationType | string | Required within parent | A string indicating the type of operation. It is expected to be 'ALL_PROPERTY_TYPES'. Default: ALL_PROPERTY One of: ALL_PROPERTY |
operator | string | Required within parent | A 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
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects with no value set for the property should be included in the operation. |
operationType | string | Required within parent | A string indicating the type of operation. The default value is 'BOOLEAN'. Default: BOOL One of: BOOL |
operator | string | Required within parent | A string representing the operator used in the boolean operation. |
value | boolean | Required within parent | A boolean representing the value to be used in the operation. |