Choose a version:

MarketingEvent

object

Requires read_marketing_events access scope.

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

Anchor to FieldsFields

Anchor to appapp •App!non-null: The app that the marketing event is attributed to.
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 marketingChannelTypemarketingChannelType •MarketingChannel: The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
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.
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.

Deprecated fields

Anchor to channelchannel •MarketingChannelDeprecated
Anchor to targetTypeDisplayTexttargetTypeDisplayText •String!non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to marketingEvent marketingEvent •query: Returns a MarketingEvent resource by ID.
Anchor to marketingEvents marketingEvents •query: A list of marketing events associated with the marketing app.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to LegacyInteroperability LegacyInteroperability •interface
Anchor to Node Node •interface

Was this section helpful?