MarketingActivity object

A marketing activity represents marketing created by an app on behalf of the merchant.

Required access

read_marketing_events access scope.

On this page

Fields

  • activityListUrl ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    The url of the activity listing page of this marketing activity in the marketing section.
  • adSpend ([MoneyV2](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    Amount spent on this marketing activity.
  • app ([App!](https://shopify.dev/docs/admin-api/graphql/reference/apps/app))
    The app which created this marketing activity.
  • appErrors ([MarketingActivityExtensionAppErrors](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivityextensionapperrors))
    Errors generated when app was trying to complete this activity.
  • budget ([MarketingBudget](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingbudget))
    The budget for this marketing activity.
  • createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the marketing activity was created.
  • formData ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The form data of the marketing activity.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • marketingChannel ([MarketingChannel!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingchannel))
    The broad category of marketing, used for reporting aggregation.
  • marketingEvent ([MarketingEvent](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingevent))
    Associated marketing event of this marketing activity.
  • sourceAndMedium ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A contextual description of the marketing activity based on the platform and tactic used.
  • status ([MarketingActivityStatus!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivitystatus))
    Status helps to identify if this marketing activity has been completed, queued, failed etc.
  • statusBadgeType ([MarketingActivityStatusBadgeType](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivitystatusbadgetype))
    StatusBadgeType helps to identify the color of the status badge.
  • statusLabel ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Status label to describe the status of the marketing activity.
  • statusTransitionedAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the activity’s status last changed.
  • tactic ([MarketingTactic!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingtactic))
    The method of marketing used for this marketing activity.
  • targetStatus ([MarketingActivityStatus](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivitystatus))
    Expected status set by app in prior to an asynchronous operation.
  • title ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Title of this marketing activity.
  • updatedAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the marketing activity was updated.
  • utmParameters ([UTMParameters](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/utmparameters))
    The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

  • [MarketingEngagement.marketingActivity](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingengagement#marketingactivity-2021-01)
  • [QueryRoot.marketingActivities](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#marketingactivities-2021-01)
  • [QueryRoot.marketingActivity](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#marketingactivity-2021-01)

Mutations for MarketingActivity

Implements

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

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

  • edges ([[MarketingActivityEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivity))
    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 MarketingActivity 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 ([MarketingActivity!](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingactivity))
    The item at the end of MarketingActivityEdge.

Types that return MarketingActivityEdge

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