MarketingActivity object

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

Fields

• activityListUrl (URL)

  The url of the activity listing page of this marketing activity in the marketing section.

• adSpend (MoneyV2)

  Amount spent on this marketing activity.

• app (App!)

  The app which created this marketing activity.

• appErrors (MarketingActivityExtensionAppErrors)

  Errors generated when app was trying to complete this activity.

• automationStepType (String)

  The step type of a marketing automation activity.

• automationTriggerDescription (String)

  The trigger description for the automation step.

• budget (MarketingBudget)

  The budget for this marketing activity.

• createdAt (DateTime!)

  The date and time when the marketing activity was created.

• errorOccurredAt (DateTime)

  The time at which the most recent error occurred, which is set by the app.

• formData (String)

  The form data of the marketing activity.

• id (ID!)

  Globally unique identifier.

• marketingChannel (MarketingChannel!)

  The broad category of marketing, used for reporting aggregation.

• marketingEvent (MarketingEvent)

  Associated marketing event of this marketing activity.

• scheduledToEndAt (DateTime)

  The scheduled end time of the activity, which is set by the app.

• scheduledToStartAt (DateTime)

  The scheduled start time of the activity, which is set by the app.

• sourceAndMedium (String!)

  A contextual description of the marketing activity based on the platform and tactic used.

• status (MarketingActivityStatus!)

  Status helps to identify if this marketing activity has been completed, queued, failed etc.

• statusBadgeType (MarketingActivityStatusBadgeType)

  StatusBadgeType helps to identify the color of the status badge.

• statusLabel (String!)

  Status label to describe the status of the marketing activity.

• statusTransitionedAt (DateTime)

  The date and time when the activity's status last changed.

• tactic (MarketingTactic!)

  The method of marketing used for this marketing activity.

• targetStatus (MarketingActivityStatus)

  Expected status set by app in prior to an asynchronous operation.

• title (String!)

  Title of this marketing activity.

• trackingOpens (Boolean!)

  Whether or not the marketing activity is tracking opens.

• updatedAt (DateTime!)

  The date and time when the marketing activity was updated.

• utmParameters (UTMParameters)

  The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

• MarketingActivity.node
• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityCreate

  Create new marketing activity.

• marketingActivityUpdate

  Updates a marketing activity.

Implements

• Node

An auto-generated type for paginating through multiple MarketingActivities.

Fields

• edges ([MarketingActivityEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

Types that return MarketingActivity

• MarketingActivity.node
• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityCreate

  Create new marketing activity.

• marketingActivityUpdate

  Updates a marketing activity.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (MarketingActivity!)

  The item at the end of MarketingActivityEdge.

Types that return MarketingActivity

• MarketingActivity.node
• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityCreate

  Create new marketing activity.

• marketingActivityUpdate

  Updates a marketing activity.

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

Fields

• activityListUrl (URL)

  The url of the activity listing page of this marketing activity in the marketing section.

• adSpend (MoneyV2)

  Amount spent on this marketing activity.

• app (App!)

  The app which created this marketing activity.

• appErrors (MarketingActivityExtensionAppErrors)

  Errors generated when app was trying to complete this activity.

• budget (MarketingBudget)

  The budget for this marketing activity.

• createdAt (DateTime!)

  The date and time when the marketing activity was created.

• formData (String)

  The form data of the marketing activity.

• id (ID!)

  Globally unique identifier.

• marketingChannel (MarketingChannel!)

  The broad category of marketing, used for reporting aggregation.

• marketingEvent (MarketingEvent)

  Associated marketing event of this marketing activity.

• sourceAndMedium (String!)

  A contextual description of the marketing activity based on the platform and tactic used.

• status (MarketingActivityStatus!)

  Status helps to identify if this marketing activity has been completed, queued, failed etc.

• statusBadgeType (MarketingActivityStatusBadgeType)

  StatusBadgeType helps to identify the color of the status badge.

• statusLabel (String!)

  Status label to describe the status of the marketing activity.

• statusTransitionedAt (DateTime)

  The date and time when the activity's status last changed.

• tactic (MarketingTactic!)

  The method of marketing used for this marketing activity.

• targetStatus (MarketingActivityStatus)

  Expected status set by app in prior to an asynchronous operation.

• title (String!)

  Title of this marketing activity.

• updatedAt (DateTime!)

  The date and time when the marketing activity was updated.

• utmParameters (UTMParameters)

  The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityCreate

  Create new marketing activity.

• marketingActivityUpdate

  Updates a marketing activity.

Implements

• Node

An auto-generated type for paginating through multiple MarketingActivities.

Fields

• edges ([MarketingActivityEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (MarketingActivity!)

  The item at the end of MarketingActivityEdge.

Types that return MarketingActivityEdge

• MarketingActivityConnection.edges

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

Fields

• activityListUrl (URL)

  The url of the activity listing page of this marketing activity in the marketing section.

• adSpend (MoneyV2)

  Amount spent on this marketing activity.

• app (App!)

  The app which created this marketing activity.

• appErrors (MarketingActivityExtensionAppErrors)

  Errors generated when app was trying to complete this activity.

• budget (MarketingBudget)

  The budget for this marketing activity.

• createdAt (DateTime!)

  The date and time when the marketing activity was created.

• formData (String)

  The form data of the marketing activity.

• id (ID!)

  Globally unique identifier.

• marketingChannel (MarketingChannel!)

  The broad category of marketing, used for reporting aggregation.

• marketingEvent (MarketingEvent)

  Associated marketing event of this marketing activity.

• sourceAndMedium (String!)

  A contextual description of the marketing activity based on the platform and tactic used.

• status (MarketingActivityStatus!)

  Status helps to identify if this marketing activity has been completed, queued, failed etc.

• statusBadgeType (MarketingActivityStatusBadgeType)

  StatusBadgeType helps to identify the color of the status badge.

• statusLabel (String!)

  Status label to describe the status of the marketing activity.

• statusTransitionedAt (DateTime)

  The date and time when the activity's status last changed.

• tactic (MarketingTactic!)

  The method of marketing used for this marketing activity.

• targetStatus (MarketingActivityStatus)

  Expected status set by app in prior to an asynchronous operation.

• title (String!)

  Title of this marketing activity.

• updatedAt (DateTime!)

  The date and time when the marketing activity was updated.

• utmParameters (UTMParameters)

  The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityCreate

  Create new marketing activity.

• marketingActivityUpdate

  Updates a marketing activity.

Implements

• Node

An auto-generated type for paginating through multiple MarketingActivities.

Fields

• edges ([MarketingActivityEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (MarketingActivity!)

  The item at the end of MarketingActivityEdge.

Types that return MarketingActivityEdge

• MarketingActivityConnection.edges

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

Fields

• activityListUrl (URL)

  The url of the activity listing page of this marketing activity in the marketing section.

• adSpend (MoneyV2)

  Amount spent on this marketing activity.

• app (App!)

  The app which created this marketing activity.

• appErrors (MarketingActivityExtensionAppErrors)

  Errors generated when app was trying to complete this activity.

• budget (MarketingBudget)

  The budget for this marketing activity.

• createdAt (DateTime!)

  The date and time when the marketing activity was created.

• id (ID!)

  Globally unique identifier.

• marketingChannel (MarketingChannel!)

  The broad category of marketing, used for reporting aggregation.

• marketingEvent (MarketingEvent)

  Associated marketing event of this marketing activity.

• sourceAndMedium (String!)

  A contextual description of the marketing activity based on the platform and tactic used.

• status (MarketingActivityStatus!)

  Status helps to identify if this marketing activity has been completed, queued, failed etc.

• statusTransitionedAt (DateTime)

  The date and time when the activity's status last changed.

• tactic (MarketingTactic!)

  The method of marketing used for this marketing activity.

• targetStatus (MarketingActivityStatus)

  Expected status set by app in prior to an asynchronous operation.

• title (String!)

  Title of this marketing activity.

• updatedAt (DateTime!)

  The date and time when the marketing activity was updated.

• utmParameters (UTMParameters)

  The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityUpdate

  Updates a marketing activity.

Implements

• Node

An auto-generated type for paginating through multiple MarketingActivities.

Fields

• edges ([MarketingActivityEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (MarketingActivity!)

  The item at the end of MarketingActivityEdge.

Types that return MarketingActivityEdge

• MarketingActivityConnection.edges

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

Fields

• activityListUrl (URL)

  The url of the activity listing page of this marketing activity in the marketing section.

• adSpend (MoneyV2)

  Amount spent on this marketing activity.

• app (App!)

  The app which created this marketing activity.

• appErrors (MarketingActivityExtensionAppErrors)

  Errors generated when app was trying to complete this activity.

• budget (MarketingBudget)

  The budget for this marketing activity.

• createdAt (DateTime!)

  The date and time when the marketing activity was created.

• id (ID!)

  Globally unique identifier.

• marketingChannel (MarketingChannel!)

  The broad category of marketing, used for reporting aggregation.

• marketingEvent (MarketingEvent)

  Associated marketing event of this marketing activity.

• sourceAndMedium (String!)

  A contextual description of the marketing activity based on the platform and tactic used.

• status (MarketingActivityStatus!)

  Status helps to identify if this marketing activity has been completed, queued, failed etc.

• statusTransitionedAt (DateTime)

  The date and time when the activity's status last changed.

• tactic (MarketingTactic!)

  The method of marketing used for this marketing activity.

• targetStatus (MarketingActivityStatus)

  Expected status set by app in prior to an asynchronous operation.

• title (String!)

  Title of this marketing activity.

• updatedAt (DateTime!)

  The date and time when the marketing activity was updated.

• utmParameters (UTMParameters)

  The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityUpdate

  Updates a marketing activity.

Implements

• Node

An auto-generated type for paginating through multiple MarketingActivities.

Fields

• edges ([MarketingActivityEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (MarketingActivity!)

  The item at the end of MarketingActivityEdge.

Types that return MarketingActivityEdge

• MarketingActivityConnection.edges

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

Fields

• activityListUrl (URL)

  The url of the activity listing page of this marketing activity in the marketing section.

• adSpend (MoneyV2)

  Amount spent on this marketing activity.

• app (App!)

  The app which created this marketing activity.

• appErrors (MarketingActivityExtensionAppErrors)

  Errors generated when app was trying to complete this activity.

• budget (MarketingBudget)

  The budget for this marketing activity.

• createdAt (DateTime!)

  The date and time when the marketing activity was created.

• id (ID!)

  Globally unique identifier.

• marketingChannel (MarketingChannel!)

  The broad category of marketing, used for reporting aggregation.

• marketingEvent (MarketingEvent)

  Associated marketing event of this marketing activity.

• sourceAndMedium (String!)

  A contextual description of the marketing activity based on the platform and tactic used.

• status (MarketingActivityStatus!)

  Status helps to identify if this marketing activity has been completed, queued, failed etc.

• statusTransitionedAt (DateTime)

  The date and time when the activity's status last changed.

• tactic (MarketingTactic!)

  The method of marketing used for this marketing activity.

• targetStatus (MarketingActivityStatus)

  Expected status set by app in prior to an asynchronous operation.

• title (String!)

  Title of this marketing activity.

• updatedAt (DateTime!)

  The date and time when the marketing activity was updated.

• utmParameters (UTMParameters)

  The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityUpdate

  Updates a marketing activity.

Implements

• Node

An auto-generated type for paginating through multiple MarketingActivities.

Fields

• edges ([MarketingActivityEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (MarketingActivity!)

  The item at the end of MarketingActivityEdge.

Types that return MarketingActivityEdge

• MarketingActivityConnection.edges

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

Fields

• activityListUrl (URL)

  The url of the activity listing page of this marketing activity in the marketing section.

• adSpend (MoneyV2)

  Amount spent on this marketing activity.

• app (App!)

  The app which created this marketing activity.

• appErrors (MarketingActivityExtensionAppErrors)

  Errors generated when app was trying to complete this activity.

• budget (MarketingBudget)

  The budget for this marketing activity.

• createdAt (DateTime!)

  The date and time when the marketing activity was created.

• id (ID!)

  Globally unique identifier.

• marketingChannel (MarketingChannel!)

  The broad category of marketing, used for reporting aggregation.

• marketingEvent (MarketingEvent)

  Associated marketing event of this marketing activity.

• sourceAndMedium (String!)

  A contextual description of the marketing activity based on the platform and tactic used.

• status (MarketingActivityStatus!)

  Status helps to identify if this marketing activity has been completed, queued, failed etc.

• statusTransitionedAt (DateTime)

  The date and time when the activity's status last changed.

• tactic (MarketingTactic!)

  The method of marketing used for this marketing activity.

• targetStatus (MarketingActivityStatus)

  Expected status set by app in prior to an asynchronous operation.

• title (String!)

  Title of this marketing activity.

• updatedAt (DateTime!)

  The date and time when the marketing activity was updated.

• utmParameters (UTMParameters)

  The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityUpdate

  Updates a marketing activity.

Implements

• Node

An auto-generated type for paginating through multiple MarketingActivities.

Fields

• edges ([MarketingActivityEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (MarketingActivity!)

  The item at the end of MarketingActivityEdge.

Types that return MarketingActivityEdge

• MarketingActivityConnection.edges

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

Fields

• activityListUrl (URL)

  The url of the activity listing page of this marketing activity in the marketing section.

• adSpend (MoneyV2)

  Amount spent on this marketing activity.

• app (App!)

  The app which created this marketing activity.

• appErrors (MarketingActivityExtensionAppErrors)

  Errors generated when app was trying to complete this activity.

• budget (MarketingBudget)

  The budget for this marketing activity.

• createdAt (DateTime!)

  The date and time when the marketing activity was created.

• id (ID!)

  Globally unique identifier.

• marketingChannel (MarketingChannel!)

  The broad category of marketing, used for reporting aggregation.

• marketingEvent (MarketingEvent)

  Associated marketing event of this marketing activity.

• sourceAndMedium (String!)

  A contextual description of the marketing activity based on the platform and tactic used.

• status (MarketingActivityStatus!)

  Status helps to identify if this marketing activity has been completed, queued, failed etc.

• statusTransitionedAt (DateTime)

  The date and time when the activity's status last changed.

• tactic (MarketingTactic!)

  The method of marketing used for this marketing activity.

• targetStatus (MarketingActivityStatus)

  Expected status set by app in prior to an asynchronous operation.

• title (String!)

  Title of this marketing activity.

• updatedAt (DateTime!)

  The date and time when the marketing activity was updated.

• utmParameters (UTMParameters)

  The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityUpdate

  Updates a marketing activity.

Implements

• Node

An auto-generated type for paginating through multiple MarketingActivities.

Fields

• edges ([MarketingActivityEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (MarketingActivity!)

  The item at the end of MarketingActivityEdge.

Types that return MarketingActivityEdge

• MarketingActivityConnection.edges

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

Fields

• activityListUrl (URL)

  The url of the activity listing page of this marketing activity in the marketing section.

• adSpend (MoneyV2)

  Amount spent on this marketing activity.

• app (App!)

  The app which created this marketing activity.

• appErrors (MarketingActivityExtensionAppErrors)

  Errors generated when app was trying to complete this activity.

• budget (MarketingBudget)

  The budget for this marketing activity.

• createdAt (DateTime!)

  The date and time when the marketing activity was created.

• id (ID!)

  Globally unique identifier.

• marketingChannel (MarketingChannel!)

  The broad category of marketing, used for reporting aggregation.

• marketingEvent (MarketingEvent)

  Associated marketing event of this marketing activity.

• sourceAndMedium (String!)

  A contextual description of the marketing activity based on the platform and tactic used.

• status (MarketingActivityStatus!)

  Status helps to identify if this marketing activity has been completed, queued, failed etc.

• statusTransitionedAt (DateTime)

  The date and time when the activity's status last changed.

• tactic (MarketingTactic!)

  The method of marketing used for this marketing activity.

• targetStatus (MarketingActivityStatus)

  Expected status set by app in prior to an asynchronous operation.

• title (String!)

  Title of this marketing activity.

• updatedAt (DateTime!)

  The date and time when the marketing activity was updated.

• utmParameters (UTMParameters)

  The set of UTM parameters being tracked for this marketing activity.

Types that return MarketingActivity

• MarketingEngagement.marketingActivity
• QueryRoot.marketingActivities
• QueryRoot.marketingActivity

Mutations for MarketingActivity

• marketingActivityUpdate

  Updates a marketing activity.

Implements

• Node

An auto-generated type for paginating through multiple MarketingActivities.

Fields

• edges ([MarketingActivityEdge!]!)

  A list of edges.

• pageInfo (PageInfo!)

  Information to aid in pagination.

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

Fields

• cursor (String!)

  A cursor for use in pagination.

• node (MarketingActivity!)

  The item at the end of MarketingActivityEdge.

Types that return MarketingActivityEdge

• MarketingActivityConnection.edges