MarketingEvents
Lists marketing events associated with the marketing application and their metrics.
View-Specific Information
Select
The driver uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The driver processes other filters client-side within the driver.
- Id supports the '=, IN' comparison operators.
- AppId supports the '=, !=' comparison operators.
- Type supports the '=, !=' comparison operators.
- StartedAt supports the '=, !=, <, >, >=, <=' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM MarketingEvents WHERE Id = 'Val1'
SELECT * FROM MarketingEvents WHERE AppId = 'Val1'
SELECT * FROM MarketingEvents WHERE Type = 'Val1'
SELECT * FROM MarketingEvents WHERE StartedAt = '2023-01-01 11:10:00'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A globally unique Id for the marketing event. | |
| RemoteId | String | An optional Id used by Shopify to validate engagement data. | |
| LegacyResourceId | String | The Id of the corresponding resource in the REST Admin API. | |
| AppId | String | A globally unique Id for the app that created the event. | |
| MarketingChannelType | String | The channel or medium through which the marketing activity reached consumers. Used for reporting aggregation. | |
| Description | String | A description of the marketing event, used to summarize the campaign or promotion. | |
| Type | String | The type of marketing event. | |
| EndedAt | Datetime | The date and time when the marketing event ended. | |
| ManageUrl | String | The URL where the marketing event can be managed. | |
| PreviewUrl | String | The URL where the marketing event can be previewed. | |
| StartedAt | Datetime | The date and time when the marketing event started. | |
| UtmCampaign | String | The UTM campaign name associated with the marketing event. | |
| UtmMedium | String | The UTM medium used in the campaign (for example, 'cpc', 'banner'). | |
| UtmSource | String | The UTM source or referrer of the campaign (for example, 'google', 'newsletter'). | |
| SourceAndMedium | String | A combined representation of where the marketing event occurred and the type of content used. Derived from 'marketingChannel', 'referringDomain', and 'type' to ensure consistency across apps. | |
| ScheduledToEndAt | Datetime | The date and time when the marketing event is scheduled to end. |