Choose a version:

MarketingEngagement

object

Marketing engagement represents customer activity taken on a marketing activity or a marketing channel.

Anchor to FieldsFields

Anchor to adSpendadSpend •MoneyV2: The total ad spend for the marketing content. Recurring weekly, monthly, or yearly spend needs to be divided into daily amounts.
Anchor to channelHandlechannelHandle •String: The unique string identifier of the channel to which the engagement metrics are being provided. This should be set when and only when providing channel-level engagements. This should be nil when providing activity-level engagements. For the correct handle for your channel, contact your partner manager.
Anchor to clicksCountclicksCount •Int: The total number of interactions, such as a button press or a screen touch, that occurred on the marketing content.
Anchor to commentsCountcommentsCount •Int: The total number of comments on the marketing content.
Anchor to complaintsCountcomplaintsCount •Int: The total number of complaints on the marketing content. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were marked as spam. For social media platforms, this represents the number of dislikes or the number of times marketing content was reported.
Anchor to failsCountfailsCount •Int: The total number of fails for the marketing content. For message-based platforms such as email or SMS, this represents the number of bounced marketing emails or messages.
Anchor to favoritesCountfavoritesCount •Int: The total number of favorites, likes, saves, or bookmarks on the marketing content.
Anchor to firstTimeCustomersfirstTimeCustomers •Decimal: The number of customers that have placed their first order. Doesn't include adjustments such as edits, exchanges, or returns.
Anchor to impressionsCountimpressionsCount •Int: The total number of times marketing content was displayed to users, whether or not an interaction occurred. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were delivered.
Anchor to isCumulativeisCumulative •Boolean!non-null: Specifies how the provided metrics have been aggregated. Cumulative metrics are aggregated from the first day of reporting up to and including occuredOn. Non-cumulative metrics are aggregated over the single day indicated in occuredOn. Cumulative metrics will monotonically increase in time as each record includes the previous day's values, and so on. Non-cumulative is strongly preferred, and support for cumulative metrics may be deprecated in the future.
Anchor to marketingActivitymarketingActivity •MarketingActivity: The marketing activity object related to this engagement. This corresponds to the marketingActivityId passed in on creation of the engagement.
Anchor to occurredOnoccurredOn •Date!non-null: The calendar date (in the time zone offset specified by the utcOffset field) for which the metrics are being reported. For example, a shop in UTC-5 would set utcOffset="-05:00" and aggregate all engagements from 05:00:00Z up to 29:00:00Z (5am UTC next day) for each call.
Anchor to ordersorders •Decimal: The number of orders generated from the marketing content.
Anchor to returningCustomersreturningCustomers •Decimal: The number of returning customers that have placed an order. Doesn't include adjustments such as edits, exchanges, or returns.
Anchor to salessales •MoneyV2: The amount of sales generated from the marketing content.
Anchor to sendsCountsendsCount •Int: The total number of marketing emails or messages that were sent.
Anchor to sessionsCountsessionsCount •Int: The number of online store sessions generated from the marketing content.
Anchor to sharesCountsharesCount •Int: The total number of times marketing content was distributed or reposted to either one's own network of followers through a social media platform or other digital channels. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were forwarded.
Anchor to uniqueClicksCountuniqueClicksCount •Int: The total number of unique clicks on the marketing content.
Anchor to uniqueViewsCountuniqueViewsCount •Int: The total number of all users who saw marketing content since it was published. For message-based platforms such as email or SMS, this represents the number of unique users that opened a marketing email or message. For video-based content, this represents the number of unique users that played video content.
Anchor to unsubscribesCountunsubscribesCount •Int: The total number of unsubscribes on the marketing content. For social media platforms, this represents the number of unfollows.
Anchor to utcOffsetutcOffset •UtcOffset!non-null: The UTC offset for the time zone in which the metrics are being reported, in the format "+HH:MM" or "-HH:MM". Used in combination with occurredOn when aggregating daily metrics. Must match the account settings for the shop to minimize eventual discrepancies in reporting.
Anchor to viewsCountviewsCount •Int: The total number of views on the marketing content. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were opened. For video-based content, this represents the number of times videos were played.

Was this section helpful?

Anchor to MutationsMutations

marketingEngagementCreate

•mutation

Creates a new marketing engagement for a marketing activity or a marketing channel.

Anchor to channelHandlechannelHandle •String: The unique string identifier of the channel to which the engagement metrics are being provided. This should be set when and only when providing channel-level engagements. This should be nil when providing activity-level engagements. For the correct handle for your channel, contact your partner manager.
Anchor to marketingActivityIdmarketingActivityId •ID: The identifier of the marketing activity for which the engagement metrics are being provided. This or the remoteId should be set when and only when providing activity-level engagements. This should be nil when providing channel-level engagements.
Anchor to marketingEngagementmarketingEngagement •MarketingEngagementInput!required: The marketing engagement's attributes.
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. This or the marketingActivityId should be set when and only when providing activity-level engagements. This should be nil when providing channel-level engagements.

Anchor to marketingEngagementmarketingEngagement •MarketingEngagement: The marketing engagement that was created. This represents customer activity taken on a marketing activity or a marketing channel.
Anchor to userErrorsuserErrors •[MarketingActivityUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to FieldsFields

Anchor to MutationsMutations

Arguments

Fields