MarketingEvent object
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
MarketingEvent.node
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
Types that return MarketingEvent
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.
Types that return MarketingEvent
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.
Types that return MarketingEventEdge
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.
Types that return MarketingEventEdge
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.
Types that return MarketingEventEdge
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.
Types that return MarketingEventEdge
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.
Types that return MarketingEventEdge
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.
Types that return MarketingEventEdge
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.
Types that return MarketingEventEdge
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.
Types that return MarketingEventEdge
Represents actions that market a merchant's store or products.
Required access
read_marketing_events
access scope.
Fields
-
app (
App!
)The app that the marketing event is attributed to.
-
channel (
MarketingChannel
)The marketing channel used by the marketing event.
-
description (
String
)A human-readable description of the marketing event.
-
endedAt (
DateTime
)The date and time when the marketing event ended.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
manageUrl (
URL
)The URL where the marketing event can be managed.
-
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!
)Where the
MarketingEvent
occurred and what kind of content was used. BecauseutmSource
andutmMedium
are often used interchangeably, this is based on a combination ofmarketingChannel
,referringDomain
, andtype
to provide a consistent representation for any given piece of marketing regardless of the app that created it. -
startedAt (
DateTime!
)The date and time when the marketing event started.
-
type (
MarketingTactic!
)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
.
Types that return MarketingEvent
-
CustomerVisit.marketingEvent
-
MarketingActivity.marketingEvent
-
QueryRoot.marketingEvent
-
QueryRoot.marketingEvents
Implements
Deprecated fields
-
targetTypeDisplayText (
String!
) deprecatedThe display text for the marketing event type.
Deprecation warning
Use
sourceAndMedium
instead
An auto-generated type for paginating through multiple MarketingEvents.
On this page
Fields
-
edges (
[MarketingEventEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one MarketingEvent and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
MarketingEvent!
)The item at the end of MarketingEventEdge.