Skip to main content
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.

Show fields
Anchor to appapp
•App!
non-null

The app that the marketing event is attributed to.

Show fields
Anchor to channelHandlechannelHandle
•String

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

Anchor to descriptiondescription
•String

A human-readable description of the marketing event.

Anchor to endedAtendedAt
•DateTime

The date and time when the marketing event ended.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to legacyResourceIdlegacyResourceId
•UnsignedInt64!
non-null

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

Anchor to manageUrlmanageUrl
•URL

The URL where the marketing event can be managed.

Anchor to marketedResourcesmarketedResources
•MarketedResourceConnection

The resources that this marketing activity advertises, in the order they were added. Resources added in the same request have no guaranteed relative order.

Show fields

Arguments

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to marketingChannelTypemarketingChannelType
•MarketingChannel

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

Show enum values
Anchor to previewUrlpreviewUrl
•URL

The URL where the marketing event can be previewed.

Anchor to remoteIdremoteId
•String

An optional ID that helps Shopify validate engagement data.

Anchor to scheduledToEndAtscheduledToEndAt
•DateTime

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

Anchor to sourceAndMediumsourceAndMedium
•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.

Anchor to startedAtstartedAt
•DateTime!
non-null

The date and time when the marketing event started.

Anchor to typetype
•MarketingTactic!
non-null

The marketing event type.

Show enum values
Anchor to utmCampaignutmCampaign
•String

The name of the marketing campaign.

Anchor to utmMediumutmMedium
•String

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

Anchor to utmSourceutmSource
•String

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

Anchor to channelchannel
•MarketingChannel
Deprecated
Show enum values
Anchor to targetTypeDisplayTexttargetTypeDisplayText
•String!
non-nullDeprecated
Was this section helpful?