MarketingEvents
Returns a list of marketing events associated with the marketing app.
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
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. | |
| RemoteId | String | An optional ID that helps Shopify validate engagement data. | |
| LegacyResourceId | String | The ID of the corresponding resource in the REST Admin API. | |
| AppId | String | A globally-unique ID. | |
| Channel | String | The marketing channel used by the marketing event. | |
| Description | String | A human-readable description of the marketing event. | |
| Type | String | The marketing event type. | |
| 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 name of the marketing campaign. | |
| UtmMedium | String | The medium that the marketing campaign is using. Example values: 'cpc', 'banner'. | |
| UtmSource | String | The referrer of the marketing event. Example values: 'google', 'newsletter'. | |
| SourceAndMedium | String | Where the 'MarketingEvent' occurred and what kind of content was used. Because 'utmSource' and 'utmMedium' are often used interchangeably, this is based on a combination of 'marketingChannel', 'referringDomain', and 'type' to provide a consistent representation for any given piece of marketing regardless of the app that created it. | |
| ScheduledToEndAt | Datetime | The date and time when the marketing event is scheduled to end. |