read_marketing_events
access scope.
Represents actions that market a merchant's store or products.
The app that the marketing event is attributed to.
The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.
A human-readable description of the marketing event.
The date and time when the marketing event ended.
A globally-unique ID.
The ID of the corresponding resource in the REST Admin API.
The URL where the marketing event can be managed.
The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
The URL where the marketing event can be previewed.
An optional ID that helps Shopify validate engagement data.
The date and time when the marketing event is scheduled to end.
Where the
occurred and what kind of content was used. Because
and
are often used interchangeably, this is based on a combination of
,
, and
type
to provide a consistent representation for any given piece of marketing regardless of the app that created it.The date and time when the marketing event started.
The marketing event type.
The name of the marketing campaign.
The medium that the marketing campaign is using. Example values:
cpc
,banner
.The referrer of the marketing event. Example values:
google
,newsletter
.
Returns a MarketingEvent resource by ID.
A list of marketing events associated with the marketing app.