API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

MarketingEvent object

Version unstable

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version unstable

An auto-generated type for paginating through multiple MarketingEvents.

Fields

Types that return MarketingEvent

Version unstable

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEvent

Version 2021-07 (Release candidate)

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2021-07 (Release candidate)

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2021-07 (Release candidate)

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

Version 2021-04 (Latest)

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2021-04 (Latest)

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2021-04 (Latest)

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

Version 2021-01

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2021-01

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2021-01

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

Version 2020-10

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2020-10

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2020-10

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

Version 2020-07

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2020-07

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2020-07

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

Version 2020-04

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2020-04

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2020-04

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

Version 2020-01 (Unsupported)

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2020-01 (Unsupported)

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2020-01 (Unsupported)

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

Version 2019-10 (Unsupported)

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2019-10 (Unsupported)

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2019-10 (Unsupported)

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

Version 2019-07 (Unsupported)

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2019-07 (Unsupported)

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2019-07 (Unsupported)

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

Version 2019-04 (Unsupported)

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. 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!)

    The date and time when the marketing event started.

  • 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

Implements

Deprecated fields

  • targetTypeDisplayText (String!) deprecated

    The display text for the marketing event type.

    Deprecation warning

    Use sourceAndMedium instead

Version 2019-04 (Unsupported)

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

Version 2019-04 (Unsupported)

An auto-generated type which holds one MarketingEvent and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge