MarketingEvent object

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

Required access

read_marketing_events access scope.

On this page

Fields

  • app ([App!](https://shopify.dev/docs/admin-api/graphql/reference/apps/app))
    The app that the marketing event is attributed to.
  • channel ([MarketingChannel](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingchannel))
    The marketing channel used by the marketing event.
  • description ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A human-readable description of the marketing event.
  • endedAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the marketing event ended.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • legacyResourceId ([UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
    The ID of the corresponding resource in the REST Admin API.
  • manageUrl ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    The URL where the marketing event can be managed.
  • previewUrl ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    The URL where the marketing event can be previewed.
  • remoteId ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    An optional ID that helps Shopify validate engagement data.
  • scheduledToEndAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the marketing event is scheduled to end.
  • sourceAndMedium ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    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!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the marketing event started.
  • type ([MarketingTactic!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingtactic))
    The marketing event type.
  • utmCampaign ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The name of the marketing campaign.
  • utmMedium ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The medium that the marketing campaign is using. Example values: cpc, banner.
  • utmSource ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The referrer of the marketing event. Example values: google, newsletter.

Types that return MarketingEvent

  • [CustomerVisit.marketingEvent](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/customervisit#marketingevent-2021-01)
  • [MarketingActivity.marketingEvent](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivity#marketingevent-2021-01)
  • [QueryRoot.marketingEvent](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#marketingevent-2021-01)
  • [QueryRoot.marketingEvents](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#marketingevents-2021-01)

Implements

  • [LegacyInteroperability](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/legacyinteroperability)
  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

An auto-generated type for paginating through multiple MarketingEvents.

On this page

Fields

  • edges ([[MarketingEventEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingevent))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/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!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([MarketingEvent!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingevent))
    The item at the end of MarketingEventEdge.

Types that return MarketingEventEdge

  • [MarketingEventConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingevent#edges-2021-01)