Represents actions that market a merchant's store or products.
Access Scopes
`read_marketing_events` access scope.
Fields
app:
App! -
The app that the marketing event is attributed to.
channel:
MarketingChannel -
The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
channelHandle:
String -
The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.
description:
String -
A human-readable description of the marketing event.
endedAt:
DateTime -
The date and time when the marketing event ended.
legacyResourceId:
UnsignedInt64! -
The ID of the corresponding resource in the REST Admin API.
manageUrl:
URL -
The URL where the marketing event can be managed.
marketingChannelType:
MarketingChannel -
The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
previewUrl:
URL -
The URL where the marketing event can be previewed.
remoteId:
String -
An optional ID that helps Shopify validate engagement data.
scheduledToEndAt:
DateTime -
The date and time when the marketing event is scheduled to end.
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.
startedAt:
DateTime! -
The date and time when the marketing event started.