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

MarketingActivity object

Version unstable

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

Required access

read_marketing_events access scope.

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.

  • Errors generated when app was trying to complete this activity.

  • automationStepType (String)

    The step type of a marketing automation activity.

  • 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 helps to identify if this marketing activity has been completed, queued, failed etc.

  • 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

Mutations for MarketingActivity

Implements

Version unstable

An auto-generated type for paginating through multiple MarketingActivities.

Fields

Types that return MarketingActivity

Mutations for MarketingActivity

Version unstable

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

Fields

Types that return MarketingActivity

Mutations for MarketingActivity

Version 2021-04 (Release candidate)

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

Required access

read_marketing_events access scope.

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.

  • 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 helps to identify if this marketing activity has been completed, queued, failed etc.

  • 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

Mutations for MarketingActivity

Implements

Version 2021-04 (Release candidate)

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

Version 2021-04 (Release candidate)

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

Fields

Types that return MarketingActivityEdge

Version 2021-01 (Latest)

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

Required access

read_marketing_events access scope.

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.

  • 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 helps to identify if this marketing activity has been completed, queued, failed etc.

  • 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

Mutations for MarketingActivity

Implements

Version 2021-01 (Latest)

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

Version 2021-01 (Latest)

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

Fields

Types that return MarketingActivityEdge

Version 2020-10

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

Required access

read_marketing_events access scope.

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.

  • 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 helps to identify if this marketing activity has been completed, queued, failed etc.

  • 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

Mutations for MarketingActivity

Implements

Version 2020-10

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

Version 2020-10

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

Fields

Types that return MarketingActivityEdge

Version 2020-07

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

Required access

read_marketing_events access scope.

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.

  • 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 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

Mutations for MarketingActivity

Implements

Version 2020-07

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

Version 2020-07

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

Fields

Types that return MarketingActivityEdge

Version 2020-04

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

Required access

read_marketing_events access scope.

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.

  • 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 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

Mutations for MarketingActivity

Implements

Version 2020-04

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

Version 2020-04

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

Fields

Types that return MarketingActivityEdge

Version 2020-01 (Unsupported)

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

Required access

read_marketing_events access scope.

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.

  • 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 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

Mutations for MarketingActivity

Implements

Version 2020-01 (Unsupported)

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

Version 2020-01 (Unsupported)

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

Fields

Types that return MarketingActivityEdge

Version 2019-10 (Unsupported)

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

Required access

read_marketing_events access scope.

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.

  • 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 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

Mutations for MarketingActivity

Implements

Version 2019-10 (Unsupported)

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

Version 2019-10 (Unsupported)

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

Fields

Types that return MarketingActivityEdge

Version 2019-07 (Unsupported)

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

Required access

read_marketing_events access scope.

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.

  • 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 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

Mutations for MarketingActivity

Implements

Version 2019-07 (Unsupported)

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

Version 2019-07 (Unsupported)

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

Fields

Types that return MarketingActivityEdge

Version 2019-04 (Unsupported)

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

Required access

read_marketing_events access scope.

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.

  • 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 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

Mutations for MarketingActivity

Implements

Version 2019-04 (Unsupported)

An auto-generated type for paginating through multiple MarketingActivities.

On this page

Fields

Version 2019-04 (Unsupported)

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

Fields

Types that return MarketingActivityEdge

Samples