MarketingActivities
Returns a list of external marketing activities.
Table-Specific Information
Select
The provider uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The provider processes other filters client-side within the provider.
- Id supports the '=, IN' comparison operators.
- Title supports the '=, !=' comparison operators.
- Tactic supports the '=, !=' comparison operators.
- CreatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
- UpdatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
- AppId supports the '=, !=' comparison operators.
- AppTitle supports the '=, !=' comparison operators.
- RemoteId supports the '=, IN' comparison operators.
- ScheduledStart supports the '=, !=, <, >, >=, <=' comparison operators.
- ScheduledEnd supports the '=, !=, <, >, >=, <=' comparison operators.
- MarketingCampaignId supports the '=, !=' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM MarketingActivities WHERE Id = 'Val1'
SELECT * FROM MarketingActivities WHERE Title = 'Val1'
SELECT * FROM MarketingActivities WHERE Tactic = 'ABANDONED_CART'
SELECT * FROM MarketingActivities WHERE CreatedAt = '2023-01-01 11:10:00'
SELECT * FROM MarketingActivities WHERE UpdatedAt = '2023-01-01 11:10:00'
SELECT * FROM MarketingActivities WHERE AppId = 'Val1'
SELECT * FROM MarketingActivities WHERE AppTitle = 'Val1'
SELECT * FROM MarketingActivities WHERE RemoteId = 'Val1'
SELECT * FROM MarketingActivities WHERE ScheduledStart = '2023-01-01 11:10:00'
SELECT * FROM MarketingActivities WHERE ScheduledEnd = '2023-01-01 11:10:00'
SELECT * FROM MarketingActivities WHERE MarketingCampaignId = 'Val1'
Insert
The following columns can be used to create a new record:
Title, Status, MarketingChannelType, Tactic, UtmSource, UtmMedium, UtmCampaign, ParentActivityId, ParentRemoteId, UrlParameterValue, AdSpendAmount, AdSpendCurrencyCode, HierarchyLevel, BudgetType, BudgetAmount, BudgetCurrencyCode, RemoteId, ScheduledStart, ScheduledEnd
The following pseudo-columns can be used to create a new record:
Start, End, ChannelHandle, ReferringDomain, RemoteUrl, RemotePreviewImageUrl
Update
The following columns can be updated:
Title, Status, MarketingChannelType, Tactic, UtmSource, UtmMedium, UtmCampaign, AdSpendAmount, AdSpendCurrencyCode, BudgetType, BudgetAmount, BudgetCurrencyCode, RemoteId, ScheduledStart, ScheduledEnd
The following pseudo-columns can be used to update a record:
Start, End, ReferringDomain, RemoteUrl, RemotePreviewImageUrl
Delete
You can delete entries by specifying the following columns:
Id, RemoteId
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
A globally-unique ID. | |
| Title | String | False |
The title of the marketing activity. | |
| Status | String | False |
The status of the marketing activity. The allowed values are ACTIVE, DELETED, DELETED_EXTERNALLY, DISCONNECTED, DRAFT, FAILED, INACTIVE, PAUSED, PENDING, SCHEDULED, UNDEFINED. | |
| MarketingChannelType | String | False |
The medium through which the marketing activity reached consumers. The allowed values are DISPLAY, SOCIAL, EMAIL, REFERRAL, SEARCH. | |
| Tactic | String | False |
The marketing tactic for the marketing activity. The allowed values are ABANDONED_CART, AD, AFFILIATE, LINK, LOYALTY, MESSAGE, NEWSLETTER, NOTIFICATION, POST, RETARGETING, SEO, STOREFRONT_APP, TRANSACTIONAL. | |
| UtmSource | String | False |
The UTM source for the marketing activity. | |
| UtmMedium | String | False |
The UTM medium for the marketing activity. | |
| UtmCampaign | String | False |
The UTM campaign for the marketing activity. | |
| UtmTerm | String | True |
Paid search terms used by a marketing campaign. | |
| UtmContent | String | True |
Identifies specific content in a marketing campaign. | |
| ActivityListUrl | String | True |
The URL of the marketing activity listing page in the marketing section. | |
| SourceAndMedium | String | True |
A contextual description of the marketing activity based on the platform and tactic used. | |
| ParentActivityId | String | True |
The ID of the parent marketing activity. | |
| ParentRemoteId | String | True |
The remote ID of the parent marketing activity. | |
| UrlParameterValue | String | True |
The value portion of the URL query parameter used in attributing sessions to this activity. | |
| IsExternal | Bool | True |
Whether the marketing activity represents an external marketing activity. | |
| StatusTransitionedAt | Datetime | True |
The date and time when the activity's status last changed. | |
| AdSpendAmount | Decimal | False |
The amount spent on the marketing activity. Decimal money amount. | |
| AdSpendCurrencyCode | String | False |
Currency of the ad spend. | |
| CreatedAt | Datetime | True |
The date and time when the marketing activity was created. | |
| UpdatedAt | Datetime | True |
The date and time when the marketing activity was updated. | |
| StatusLabel | String | True |
The rendered status of the marketing activity. | |
| HierarchyLevel | String | True |
The hierarchy level of the marketing activity. | |
| InMainWorkflowVersion | Bool | True |
Whether the marketing activity is in the main workflow version of marketing automation. | |
| TargetStatus | String | True |
The status to which the marketing activity is currently transitioning. | |
| FormData | String | True |
The completed content in the marketing activity creation form. | |
| AppId | String | True |
A globally-unique ID of the app which created this marketing activity. | |
| AppTitle | String | True |
The name of the app which created this marketing activity. | |
| AppErrorCode | String | True |
The error code generated when an app publishes the marketing activity. | |
| AppUserErrors | String | True |
The list of errors returned by the app. | |
| BudgetType | String | False |
The budget type for the marketing activity. | |
| BudgetAmount | Decimal | False |
The amount of budget for the marketing activity. | |
| BudgetCurrencyCode | String | False |
The currency code for the marketing activity budget. | |
| StatusBadgeTypeV2 | String | True |
The severity of the marketing activity's status. | |
| MarketingEventId | String | True |
A globally-unique ID of the associated marketing event. | |
| RemoteId | String | False |
An optional ID that helps Shopify validate engagement data. | |
| ScheduledStart | Datetime | False |
The date and time at which the activity is scheduled to start. | |
| ScheduledEnd | Datetime | False |
The date and time at which the activity is scheduled to end. | |
| MarketingCampaignId | String | True |
The id of the marketing campaign. |
Pseudo-Columns
Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.
| Name | Type | Description |
| Start | Datetime |
The date and time at which the activity started. |
| End | Datetime |
The date and time at which the activity ended. |
| ChannelHandle | String |
The unique string identifier of the channel to which this activity belongs. |
| ReferringDomain | String |
The domain from which ad clicks are forwarded to the shop. |
| RemoteUrl | String |
The URL for viewing and/or managing the activity outside of Shopify. |
| RemotePreviewImageUrl | String |
The preview image URL for the marketing activity. |