Choose a version:

marketingActivity

query

Returns a MarketingActivity resource by ID.

Arguments

Anchor to idid • ID!required: The ID of the MarketingActivity to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

MarketingActivity

•

MarketingActivity

The marketing activity resource represents marketing that a merchant created through an app.

activityListUrl• URL: The URL of the marketing activity listing page in the marketing section.
adminEditUrl• URL! non-null: The admin url used to edit this activity.
adSpend• MoneyV2: The amount spent on the marketing activity.
app• App! non-null: The app which created this marketing activity.
appErrors• MarketingActivityExtensionAppErrors: The errors generated when an app publishes the marketing activity.
automationStepType• String: The step type of a marketing automation activity.
budget• MarketingBudget: The allocated budget for the marketing activity.
createdAt• DateTime! non-null: 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.
flowEditorUrl• URL: The flow editor URL to which the marketing activity is associated.
formData• String: The completed content in the marketing activity creation form.
hierarchyLevel• MarketingActivityHierarchyLevel: The hierarchy level of the marketing activity.
id• ID! non-null: A globally-unique ID.
inMainWorkflowVersion• Boolean! non-null: Whether the marketing activity is in the main workflow version of the marketing automation.
isExternal• Boolean! non-null: The marketing activity represents an external marketing activity.
marketingChannelType• MarketingChannel! non-null: 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.
scheduledToEndAt• DateTime: The scheduled end time of the marketing activity, which is set by the app.
scheduledToStartAt• DateTime: The scheduled start time of the marketing activity, which is set by the app.
sourceAndMedium• String! non-null: A contextual description of the marketing activity based on the platform and tactic used.
status• MarketingActivityStatus! non-null: The current state of the marketing activity.
statusBadgeTypeV2• BadgeType: The severity of the marketing activity's status.
statusLabel• String! non-null: The rendered status of the marketing activity.
statusTransitionedAt• DateTime: The date and time when the activity's status last changed.
tactic• MarketingTactic! non-null: The method of marketing used for this marketing activity.
targetStatus• MarketingActivityStatus: The status to which the marketing activity is currently transitioning.
title• String! non-null: The marketing activity's title, which is rendered on the marketing listing page.
trackingOpens• Boolean! non-null: Whether the marketing activity is tracking opens.
updatedAt• DateTime! non-null: 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 used in the URL for tracking this marketing activity.
marketingChannel• MarketingChannel! non-nullDeprecated: The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation. Use marketingChannelType instead.
statusBadgeType• MarketingActivityStatusBadgeType Deprecated: The severity of the marketing activity's status. Use statusBadgeTypeV2 instead.

Was this section helpful?