MarketingEvents
Stores marketing campaign events and metadata, such as channel, UTM parameters, and performance timestamps.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Long | True |
A unique numeric identifier for the marketing event. | |
| RemoteId | String | False |
An optional identifier for the event in an external or partner system. | |
| BreadcrumbId | String | True |
An optional identifier used to track a chain or group of related marketing events. | |
| UTMCampaign | String | True |
The unique name of the UTM campaign used for tracking performance. | |
| UTMSource | String | True |
The source of the traffic for the UTM campaign, such as 'google' or 'newsletter'. | |
| UTMMedium | String | True |
The marketing medium for the UTM campaign, such as 'cpc', 'social', or 'email'. | |
| UTMContent | String | True |
The content label for the UTM campaign, used to differentiate ads or creatives within the same campaign. | |
| UTMTerm | String | True |
The keyword term associated with the UTM campaign, typically used for paid search tracking. | |
| EventTarget | String | True |
The target or destination of the marketing event, such as a landing page or campaign URL. | |
| Description | String | True |
A detailed description of the marketing event. | |
| MarketingChannel | String | False |
The marketing channel category for the event. Valid values include: 'search', 'display', 'social', 'email', and 'referral'. | |
| EventType | String | False |
The specific type of marketing event. Valid values include: 'ad', 'post', 'message', 'retargeting', 'transactional', 'affiliate', 'loyalty', 'newsletter', 'abandoned_cart', and 'receipt'. | |
| Budget | Decimal | False |
The total monetary budget allocated for the campaign. | |
| Paid | Bool | False |
Indicates whether the marketing event is paid or organic. | |
| BudgetType | String | False |
Specifies whether the budget is 'daily' or 'lifetime'. | |
| Currency | String | False |
The currency code (ISO 4217 format) used for the campaign budget. | |
| ManageUrl | String | True |
A URL linking to the management interface for the marketing event, typically within the Shopify app. | |
| PreviewUrl | String | True |
A URL to preview the live or rendered version of the marketing asset, such as an ad, email, or social post. | |
| ReferringDomain | String | False |
The destination or referring domain for the marketing event. Required unless the MarketingChannel is 'email', 'referral', or 'display'. | |
| MarketedResources | String | True |
A JSON array listing the resources promoted in the event. Each entry includes a 'type' (product, collection, price_rule, page, article, or homepage) and, when applicable, an 'id'. | |
| StartedAt | Datetime | False |
The date and time when the marketing activity began, such as when an ad went live or an email was sent. | |
| EndedAt | Datetime | False |
The date and time when the marketing activity actually ended. May differ from the scheduled end time if the event was stopped early. | |
| ScheduledToEndAt | Datetime | False |
The date and time when the marketing activity was originally scheduled to end. |