Skip to main content
Log inSign up
query

Returns a MarketingEvent resource by ID.

ID!required

The ID of the MarketingEvent to return.


Was this section helpful?

Represents actions that market a merchant's store or products.

app
non-null

The app that the marketing event is attributed to.

channelHandle

The unique string identifier of the channel to which this activity belongs. For the correct handle for your channel, contact your partner manager.

description

A human-readable description of the marketing event.

endedAt

The date and time when the marketing event ended.

id
non-null

A globally-unique ID.

legacyResourceId
non-null

The ID of the corresponding resource in the REST Admin API.

manageUrl

The URL where the marketing event can be managed.

marketingChannelType

The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.

previewUrl

The URL where the marketing event can be previewed.

remoteId

An optional ID that helps Shopify validate engagement data.

scheduledToEndAt

The date and time when the marketing event is scheduled to end.

sourceAndMedium
non-null

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
non-null

The date and time when the marketing event started.

type
non-null

The marketing event type.

utmCampaign

The name of the marketing campaign.

utmMedium

The medium that the marketing campaign is using. Example values: cpc, banner.

utmSource

The referrer of the marketing event. Example values: google, newsletter.

channel

The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.

targetTypeDisplayText
non-null

The display text for the marketing event type.


Was this section helpful?