HubSpot: Object tags schemas (part 3)
39 HubSpot schemas with complete fields and constraints.
← Object tags operations · All schemas
Create tag — response body — filterBranch / filterBranchType: NOT ALL
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Create tag — response body — filterBranch / filterBranchType: AND, Create tag — response body — filterBranch / filterBranchType: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CTA, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Create tag — response body — filterBranch / filterBranchType: NOT ALL, Create tag — response body — filterBranch / filterBranchType: NOT ANY, Create tag — response body — filterBranch / filterBranchType: OR, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Create tag — response body — filterBranch / filterBranchType: RESTRICTED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Create tag — response body — filterBranch / filterBranchType: NOT ANY
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Create tag — response body — filterBranch / filterBranchType: AND, Create tag — response body — filterBranch / filterBranchType: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CTA, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Create tag — response body — filterBranch / filterBranchType: NOT ALL, Create tag — response body — filterBranch / filterBranchType: NOT ANY, Create tag — response body — filterBranch / filterBranchType: OR, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Create tag — response body — filterBranch / filterBranchType: RESTRICTED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Create tag — response body — filterBranch / filterBranchType: OR
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Create tag — response body — filterBranch / filterBranchType: AND, Create tag — response body — filterBranch / filterBranchType: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CTA, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Create tag — response body — filterBranch / filterBranchType: NOT ALL, Create tag — response body — filterBranch / filterBranchType: NOT ANY, Create tag — response body — filterBranch / filterBranchType: OR, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Create tag — response body — filterBranch / filterBranchType: RESTRICTED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Create tag — response body — filterBranch / filterBranchType: 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'. Known values: ADS_SEARCH Default: 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 — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS TIME
Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
associationCategory | string | Required within parent | A string indicating the category of the association. |
associationTypeId | JSON | Required within parent | |
associationTypeId (anyOf 1) | integer | Alternative | An integer representing the unique identifier for the type of association. Format: int32 |
associationTypeId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
coalescingRefineBy | JSON | Required within parent | An object used to refine the filter by combining multiple criteria. It can be one of several predefined schemas such as PublicNumOccurrencesRefineBy or PublicTimePointOperation. |
coalescingRefineBy (anyOf 1) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
coalescingRefineBy (anyOf 2) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
coalescingRefineBy (anyOf 3) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
coalescingRefineBy (anyOf 4) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
coalescingRefineBy (anyOf 5) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
coalescingRefineBy (anyOf 6) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
coalescingRefineBy (anyOf 7) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
coalescingRefineBy (anyOf 8) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT |
coalescingRefineBy (anyOf 9) | Model | Alternative | Expand Create tag — response 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'. Known values: ASSOCIATION Default: 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 — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: 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'. Known values: COMMUNICATION_SUBSCRIPTION Default: COMMUNICATION_SUBSCRIPTION |
subscriptionIds | array | Required within parent | An array of strings representing the IDs of the subscriptions to be filtered. |
subscriptionIds[] | string | Each item | |
subscriptionType | string | Required within parent | A string indicating the type of subscription being filtered. |
Create tag — response 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'. Known values: CONSTANT Default: 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 — response body — filterBranch / filterBranchType: OR filters item filter Type: CTA
Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: 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'. Known values: EMAIL_EVENT Default: EMAIL_EVENT |
level | string | Required within parent | A string representing the level of the email event. |
operator | string | Required within parent | A string 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'. Known values: BOUNCED, LINK_CLICKED, MARKED_SPAM, OPENED, OPENED_BUT_LINK_NOT_CLICKED, OPENED_BUT_NOT_REPLIED, RECEIVED, RECEIVED_BUT_NOT_OPENED, REPLIED, SENT, SENT_BUT_LINK_NOT_CLICKED, SENT_BUT_NOT_RECEIVED, UNSUBSCRIBED |
pruningRefineBy | JSON | Optional | An object that allows further refinement of the filter based on various criteria such as occurrences or time points. |
pruningRefineBy (anyOf 1) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES |
pruningRefineBy (anyOf 2) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES |
pruningRefineBy (anyOf 3) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE |
pruningRefineBy (anyOf 4) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED |
pruningRefineBy (anyOf 5) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE |
pruningRefineBy (anyOf 6) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED |
pruningRefineBy (anyOf 7) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY |
pruningRefineBy (anyOf 8) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT |
pruningRefineBy (anyOf 9) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED |
Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: 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. Known values: EMAIL_SUBSCRIPTION Default: EMAIL_SUBSCRIPTION |
subscriptionIds | array | Required within parent | An array of strings representing the IDs of the subscriptions to be filtered. |
subscriptionIds[] | string | Each item | |
subscriptionType | string | Optional | A string representing the type of subscription, which may be used to further refine the filter. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EVENT
Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT
Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT
Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filterType | string | Required within parent | A string that specifies the type of filter. The default value is 'IN_LIST'. Known values: IN_LIST Default: IN_LIST |
listId | string | Required within parent | A string representing the unique identifier of the list to filter against. |
metadata | Model | Optional | Expand Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata |
operator | string | Required within parent | A string representing the operator used in the filter. |
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier for the list filter. It is a string value. |
inListType | string | Required within parent | The type of the list filter, represented as a string. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
eventTypeId | JSON | Required within parent | |
eventTypeId (anyOf 1) | integer | Alternative | A string representing the unique identifier of the event type being filtered. Format: int32 |
eventTypeId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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 — response 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'. Known values: INTEGRATION_EVENT Default: INTEGRATION_EVENT |
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW
Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: 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. Known values: PRIVACY Default: 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 — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: 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'. Known values: ALL_PROPERTY Default: ALL_PROPERTY |
operator | string | Required within parent | A string representing the operator used in the operation. |
Create tag — response 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'. Known values: BOOL Default: 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. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fiscalYearStart | string | Optional | A string specifying the start month of the fiscal year. Valid values include 'JANUARY', 'FEBRUARY', 'MARCH', 'APRIL', 'MAY', 'JUNE', 'JULY', 'AUGUST', 'SEPTEMBER', 'OCTOBER', 'NOVEMBER', and 'DECEMBER'. Known values: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects without a set value should be included in the operation. |
operationType | string | Required within parent | A string that specifies the type of operation. The default and only valid value is 'CALENDAR_DATE'. Known values: CALENDAR_DATE Default: CALENDAR_DATE |
operator | string | Required within parent | A string representing the operator used in the operation. The specific operators available are not detailed in the specification. |
timeUnit | string | Required within parent | A string representing the unit of time involved in the operation. The specific time units available are not detailed in the specification. |
timeUnitCount | JSON | Optional | |
timeUnitCount (anyOf 1) | integer | Alternative | An integer representing the count of the time units involved in the operation. Format: int32 |
timeUnitCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
useFiscalYear | boolean | Optional | A boolean indicating whether the fiscal year should be used in the operation. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparisonPropertyName | string | Required within parent | A string representing the name of the property to be compared. |
defaultComparisonValue | string | Optional | A string specifying the default value to use for comparison if the comparison property is not set. |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects without a set value for the property should be included in the operation. |
operationType | string | Required within parent | A string indicating the type of operation, which is always 'COMPARATIVE_DATE'. Known values: COMPARATIVE_DATE Default: COMPARATIVE_DATE |
operator | string | Required within parent | A string that specifies the comparison operator used in the operation. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparisonPropertyName | string | Required within parent | |
defaultComparisonValue | string | Optional | |
includeObjectsWithNoValueSet | boolean | Required within parent | |
operationType | string | Required within parent | Known values: COMPARATIVE_NUMBER Default: COMPARATIVE_NUMBER |
operator | string | Required within parent |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparisonPropertyName | string | Required within parent | A string specifying the name of the property to be compared. |
defaultComparisonValue | string | Optional | A string that provides a default value for comparison if the property value is not set. |
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 that indicates the type of operation being performed. It defaults to 'COMPARATIVE_STRING'. Known values: COMPARATIVE_PROPERTY_UPDATED Default: COMPARATIVE_PROPERTY_UPDATED |
operator | string | Required within parent | A string representing the operator used in the comparison. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparisonPropertyName | string | Required within parent | A string specifying the name of the property to be compared. |
defaultComparisonValue | string | Optional | A string providing a default value for comparison if the property being compared has no value. |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set for the property being compared. |
operationType | string | Required within parent | A string indicating the type of operation, which is 'COMPARATIVE_STRING' for this component. Known values: COMPARATIVE_STRING Default: COMPARATIVE_STRING |
operator | string | Required within parent | A string representing the operator used in the comparison. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | JSON | Required within parent | |
day (anyOf 1) | integer | Alternative | An integer representing the day component of the date. Format: int32 |
day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects with no value set should be included in the operation. |
month | string | Required within parent | A string representing the month component of the date. |
operationType | string | Required within parent | A string that specifies the type of operation. The default and only valid value is 'DATE'. Known values: DATE Default: DATE |
operator | string | Required within parent | A string representing the operator used in the date operation. The specific operators are not detailed in the spec. |
year | JSON | Required within parent | |
year (anyOf 1) | integer | Alternative | An integer representing the year component of the date. Format: int32 |
year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects without a set value should be included in the operation. |
operationType | string | Required within parent | A string representing the type of operation. The default and only valid value is 'DATETIME'. Known values: DATETIME Default: DATETIME |
operator | string | Required within parent | A string indicating the operator used in the operation. The specific operators are not detailed in the spec. |
requiresTimeZoneConversion | boolean | Required within parent | A boolean indicating whether the operation requires conversion based on time zones. |
timestamp | JSON | Required within parent | |
timestamp (anyOf 1) | integer | Alternative | An integer representing the timestamp for the operation, formatted as an int64. Format: int64 |
timestamp (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set for the enumeration property. |
operationType | string | Required within parent | A string indicating the type of operation, which is 'ENUMERATION' by default. Known values: ENUMERATION Default: ENUMERATION |
operator | string | Required within parent | A string representing the operator to be used in the enumeration operation. |
values | array | Required within parent | An array of strings representing the values involved in the enumeration operation. |
values[] | string | Each item |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects without a value set should be included in the operation. |
operationType | string | Required within parent | A string that specifies the type of operation. The default value is 'MULTISTRING'. Known values: MULTISTRING Default: MULTISTRING |
operator | string | Required within parent | A string that defines the operator used in the operation. |
values | array | Required within parent | An array of strings representing the values involved in the operation. |
values[] | string | Each item |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
| 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 that specifies the type of operation. The default value is 'NUMBER'. Known values: NUMBER Default: NUMBER |
operator | string | Required within parent | A string representing the operator used in the numeric operation. |
value | JSON | Required within parent | |
value (anyOf 1) | number | Alternative | A number representing the value involved in the operation. |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that do not have a value set for the property. |
lowerBound | JSON | Required within parent | |
lowerBound (anyOf 1) | integer | Alternative | An integer specifying the lower bound of the range, in int64 format. Format: int64 |
lowerBound (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
operationType | string | Required within parent | A string that indicates the type of operation. The default value is 'RANGED_NUMBER'. Known values: NUMBER_RANGED Default: NUMBER_RANGED |
operator | string | Required within parent | A string representing the operator used in the operation. |
upperBound | JSON | Required within parent | |
upperBound (anyOf 1) | integer | Alternative | An integer specifying the upper bound of the range, in int64 format. Format: int64 |
upperBound (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set for the date property. |
lowerBound | JSON | Required within parent | |
lowerBound (anyOf 1) | integer | Alternative | An integer representing the lower bound of the date range, in Unix timestamp format (int64). Format: int64 |
lowerBound (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
operationType | string | Required within parent | A string indicating the type of operation, which is 'RANGED_DATE' by default. Known values: RANGED_DATE Default: RANGED_DATE |
operator | string | Required within parent | A string representing the operator used in the operation. |
requiresTimeZoneConversion | boolean | Required within parent | A boolean indicating whether the operation requires time zone conversion. |
upperBound | JSON | Required within parent | |
upperBound (anyOf 1) | integer | Alternative | An integer representing the upper bound of the date range, in Unix timestamp format (int64). Format: int64 |
upperBound (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
| 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. |
numberOfDays | JSON | Required within parent | |
numberOfDays (anyOf 1) | integer | Alternative | An integer specifying the number of days for the rolling date range. Format: int32 |
numberOfDays (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
operationType | string | Required within parent | A string indicating the type of operation, which is 'ROLLING_DATE_RANGE' for this component. Known values: ROLLING_DATE_RANGE Default: ROLLING_DATE_RANGE |
operator | string | Required within parent | A string representing the operator used in the date range operation. |
requiresTimeZoneConversion | boolean | Required within parent | A boolean indicating whether the operation requires time zone conversion. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
| 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. |
numberOfDays | JSON | Required within parent | |
numberOfDays (anyOf 1) | integer | Alternative | An integer specifying the number of days over which the rolling update operation applies. Format: int32 |
numberOfDays (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
operationType | string | Required within parent | A string indicating the type of operation, which is 'ROLLING_PROPERTY_UPDATED' for this component. Known values: ROLLING_PROPERTY_UPDATED Default: ROLLING_PROPERTY_UPDATED |
operator | string | Required within parent | A string representing the operator used in the operation. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set for the property. |
operationType | string | Required within parent | A string indicating the type of operation, defaulting to 'STRING'. Known values: STRING Default: STRING |
operator | string | Required within parent | A string specifying the operator used in the operation. |
value | string | Required within parent | A string representing the value associated with the operation. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filterType | string | Required within parent | A string representing the type of filter. The default value is 'SURVEY_MONKEY', and it must be 'SURVEY_MONKEY'. Known values: SURVEY_MONKEY Default: SURVEY_MONKEY |
operator | string | Required within parent | A string representing the operation to be applied in the filter. The specific operations available are not detailed in the spec. |
surveyId | string | Required within parent | A string that specifies the unique identifier of the SurveyMonkey survey to be filtered. |
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER