Skip to main content
Anchor to MarketingActivity

MarketingActivity

object

Requires read_marketing_events access scope.

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

Anchor to FieldsFields

Anchor to activityListUrlactivityListUrl
•URL

The URL of the marketing activity listing page in the marketing section.

Anchor to adSpendadSpend
•MoneyV2

The amount spent on the marketing activity.

Anchor to appapp
•App!
non-null

The app which created this marketing activity.

Anchor to appErrorsappErrors
•MarketingActivityExtensionAppErrors

The errors generated when an app publishes the marketing activity.

Anchor to budgetbudget
•MarketingBudget

The allocated budget for the marketing activity.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the marketing activity was created.

Anchor to formDataformData
•String

The completed content in the marketing activity creation form.

Anchor to hierarchyLevelhierarchyLevel
•MarketingActivityHierarchyLevel

The hierarchy level of the marketing activity.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to inMainWorkflowVersioninMainWorkflowVersion
•Boolean!
non-null

Whether the marketing activity is in the main workflow version of the marketing automation.

Anchor to isExternalisExternal
•Boolean!
non-null

The marketing activity represents an external marketing activity.

Anchor to marketingChannelTypemarketingChannelType
•MarketingChannel!
non-null

The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.

Anchor to marketingEventmarketingEvent
•MarketingEvent

Associated marketing event of this marketing activity.

Anchor to parentActivityIdparentActivityId
•ID

ID of the parent activity of this marketing activity.

Anchor to parentRemoteIdparentRemoteId
•String

ID of the parent activity of this marketing activity.

Anchor to sourceAndMediumsourceAndMedium
•String!
non-null

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

Anchor to statusstatus
•MarketingActivityStatus!
non-null

The current state of the marketing activity.

Anchor to statusBadgeTypeV2statusBadgeTypeV2
•BadgeType

The severity of the marketing activity's status.

Anchor to statusLabelstatusLabel
•String!
non-null

The rendered status of the marketing activity.

Anchor to statusTransitionedAtstatusTransitionedAt
•DateTime

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

Anchor to tactictactic
•MarketingTactic!
non-null

The method of marketing used for this marketing activity.

Anchor to targetStatustargetStatus
•MarketingActivityStatus

The status to which the marketing activity is currently transitioning.

Anchor to titletitle
•String!
non-null

The marketing activity's title, which is rendered on the marketing listing page.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The date and time when the marketing activity was updated.

Anchor to urlParameterValueurlParameterValue
•String

The value portion of the URL query parameter used in attributing sessions to this activity.

Anchor to utmParametersutmParameters
•UTMParameters

The set of Urchin Tracking Module used in the URL for tracking this marketing activity.

Deprecated fields

Anchor to marketingChannelmarketingChannel
•MarketingChannel!
non-nullDeprecated
Anchor to statusBadgeTypestatusBadgeType
•MarketingActivityStatusBadgeType
Deprecated
Was this section helpful?

Anchor to QueriesQueries

Anchor to marketingActivitiesmarketingActivities
•query

A list of marketing activities associated with the marketing app.

Arguments

Anchor to marketingActivityIdsmarketingActivityIds
•[ID!]
Default:[]

The list of marketing activity IDs to filter by.

Anchor to remoteIdsremoteIds
•[String!]
Default:[]

The list of remote IDs associated with marketing activities to filter by.

Anchor to utmutm
•UTMInput

The UTM parameters associated with marketing activities to filter by.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•MarketingActivitySortKeys
Default:CREATED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to app_id
•id
Anchor to app_name
•string

A comma-separated list of app names.

Anchor to created_at
•time
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to marketing_campaign_id
•id
Anchor to scheduled_to_end_at
•time
Anchor to scheduled_to_start_at
•time
Anchor to tactic
•string
Anchor to title
•string
Anchor to updated_at
•time
Anchor to savedSearchIdsavedSearchId
•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to marketingActivitymarketingActivity
•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 MutationsMutations

Anchor to marketingActivityCreatemarketingActivityCreate
•mutation

Create new marketing activity. Marketing activity app extensions are deprecated and will be removed in the near future.

Arguments

Anchor to inputinput
•MarketingActivityCreateInput!
required

The Input of marketing activity create.

Anchor to marketingActivityCreateExternalmarketingActivityCreateExternal
•mutation

Creates a new external marketing activity.

Arguments

Anchor to inputinput
•MarketingActivityCreateExternalInput!
required

The input field for creating an external marketing activity.

Anchor to marketingActivityUpdatemarketingActivityUpdate
•mutation

Updates a marketing activity with the latest information. Marketing activity app extensions are deprecated and will be removed in the near future.

Arguments

Anchor to inputinput
•MarketingActivityUpdateInput!
required

The Input of the marketing activity.

Anchor to marketingActivityUpdateExternalmarketingActivityUpdateExternal
•mutation

Update an external marketing activity.

Arguments

Anchor to inputinput
•MarketingActivityUpdateExternalInput!
required

The input field for updating an external marketing activity.

Anchor to marketingActivityIdmarketingActivityId
•ID

The ID of the marketing activity. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.

Anchor to remoteIdremoteId
•String

A custom unique identifier for the marketing activity, which can be used to manage the activity and send engagement metrics without having to store our marketing activity ID in your systems. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.

Anchor to utmutm
•UTMInput

Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign. Specify either the marketing activity ID, remote ID, or UTM to update the marketing activity.

Anchor to marketingActivityUpsertExternalmarketingActivityUpsertExternal
•mutation

Creates a new external marketing activity or updates an existing one. When optional fields are absent or null, associated information will be removed from an existing marketing activity.

Arguments

Anchor to inputinput
•MarketingActivityUpsertExternalInput!
required

The input field for creating or updating an external marketing activity.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?