Skip to main content
Shopify.devShopify.devDocs
Log inSign up

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

Anchor to marketingEvent

marketingEvent

query

Returns a MarketingEvent resource by ID.

Anchor to Arguments

Arguments

Anchor to idid
•
ID!required

The ID of the MarketingEvent to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to MarketingEventMarketingEvent
•
MarketingEvent

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

app•
App!
non-null

The app that the marketing event is attributed to.

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.

id•
ID!
non-null

A globally-unique ID.

legacyResourceId•
UnsignedInt64!
non-null

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!
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•
DateTime!
non-null

The date and time when the marketing event started.

type•
MarketingTactic!
non-null

The marketing event type.

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.

channel•
MarketingChannel
Deprecated

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

targetTypeDisplayText•
String!
non-nullDeprecated

The display text for the marketing event type. Use sourceAndMedium instead.

Was this section helpful?