MarketingActivity - admin-graphql - OBJECT
Version: 2024-01
Description:
The marketing activity resource represents marketing that a
merchant created through an app.
Access Scopes
`read_marketing_events` access scope.
Fields
-
activityListUrl:
URL -
The URL of the marketing activity listing page in the marketing section.
-
adSpend:
MoneyV2 -
The amount spent on the marketing activity.
-
app:
App! -
The app which created this marketing activity.
-
appErrors:
MarketingActivityExtensionAppErrors -
The errors generated when an app publishes the marketing activity.
-
budget:
MarketingBudget -
The allocated budget for the marketing activity.
-
createdAt:
DateTime! -
The date and time when the marketing activity was created.
-
formData:
String -
The completed content in the marketing activity creation form.
-
hierarchyLevel:
MarketingActivityHierarchyLevel -
The hierarchy level of the marketing activity.
-
id:
ID! -
A globally-unique ID.
-
inMainWorkflowVersion:
Boolean! -
Whether the marketing activity is in the main workflow version of the marketing automation.
-
marketingChannel:
MarketingChannel! -
The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
-
marketingChannelType:
MarketingChannel! -
The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
-
marketingEvent:
MarketingEvent -
Associated marketing event of this marketing activity.
-
parentActivityId:
ID -
ID of the parent activity of this marketing activity.
-
parentRemoteId:
String -
ID of the parent activity of this marketing activity.
-
sourceAndMedium:
String! -
A contextual description of the marketing activity based on the platform and tactic used.
-
status:
MarketingActivityStatus! -
The current state of the marketing activity.
-
statusBadgeType:
MarketingActivityStatusBadgeType -
The severity of the marketing activity's status.
-
statusBadgeTypeV2:
BadgeType -
The severity of the marketing activity's status.
-
statusLabel:
String! -
The rendered status of the marketing activity.
-
statusTransitionedAt:
DateTime -
The [date and time](
https://help.shopify.com/https://en.wikipedia.org/wiki/ISO_8601
) when the activity's status last changed.
-
tactic:
MarketingTactic! -
The method of marketing used for this marketing activity.
-
targetStatus:
MarketingActivityStatus -
The status to which the marketing activity is currently transitioning.
-
title:
String! -
The marketing activity's title, which is rendered on the marketing listing page.
-
updatedAt:
DateTime! -
The date and time when the marketing activity was updated.
-
urlParameterValue:
String -
The value portion of the URL query parameter used in attributing sessions to this activity.
-
utmParameters:
UTMParameters -
The set of [Urchin Tracking Module](
https://help.shopify.com/https://en.wikipedia.org/wiki/UTM_parameters
) used in the URL for tracking this marketing activity.
Connections
Related queries
Related mutations
Related Unions
Examples