MarketingActivity
Requires access scope.
The marketing activity resource represents marketing that a merchant created through an app.
Anchor to FieldsFields
- Anchor to activityListUrlactivity•
List Url The URL of the marketing activity listing page in the marketing section.
- Anchor to adSpendad•
Spend The amount spent on the marketing activity.
- •App!non-null
The app which created this marketing activity.
- Anchor to appErrorsapp•
Errors The errors generated when an app publishes the marketing activity.
- Anchor to budgetbudget•
The allocated budget for the marketing activity.
- Anchor to createdAtcreated•
At DateTime! non-null The date and time when the marketing activity was created.
- Anchor to formDataform•
Data The completed content in the marketing activity creation form.
- Anchor to hierarchyLevelhierarchy•
Level The hierarchy level of the marketing activity.
- •ID!non-null
A globally-unique ID.
- Anchor to inMainWorkflowVersionin•
Main Workflow Version Boolean!non-null Whether the marketing activity is in the main workflow version of the marketing automation.
- Anchor to isExternalis•
External Boolean!non-null The marketing activity represents an external marketing activity.
- Anchor to marketingChannelTypemarketing•
Channel Type MarketingChannel! non-null The medium through which the marketing activity and event reached consumers. This is used for reporting aggregation.
- Anchor to marketingEventmarketing•
Event Associated marketing event of this marketing activity.
- Anchor to parentActivityIdparent•
Activity Id ID of the parent activity of this marketing activity.
- Anchor to parentRemoteIdparent•
Remote Id ID of the parent activity of this marketing activity.
- Anchor to sourceAndMediumsource•
And Medium String!non-null A contextual description of the marketing activity based on the platform and tactic used.
- Anchor to statusstatus•Marketing
Activity non-nullStatus! The current state of the marketing activity.
- Anchor to statusBadgeTypeV2status•
Badge Type V2 The severity of the marketing activity's status.
- Anchor to statusLabelstatus•
Label String!non-null The rendered status of the marketing activity.
- Anchor to statusTransitionedAtstatus•
Transitioned At The date and time when the activity's status last changed.
- Anchor to tactictactic•Marketing
Tactic! non-null The method of marketing used for this marketing activity.
- Anchor to targetStatustarget•
Status 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 updatedAtupdated•
At DateTime! non-null The date and time when the marketing activity was updated.
- Anchor to urlParameterValueurl•
Parameter Value The value portion of the URL query parameter used in attributing sessions to this activity.
- Anchor to utmParametersutm•
Parameters The set of Urchin Tracking Module used in the URL for tracking this marketing activity.
Anchor to QueriesQueries
- •query
A list of marketing activities associated with the marketing app.
- •query
Returns a MarketingActivity resource by ID.
Anchor to MutationsMutations
- •mutation
Create new marketing activity.
- •mutation
Creates a new external marketing activity.
- •mutation
Updates a marketing activity with the latest information.
- •mutation
Update an external marketing activity.
- •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.