marketingEngagementCreate mutation

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

On this page

• Interactive example
• Arguments
• MarketingEngagementInput fields
• Return fields

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

<font style="color:#1F61A0;">marketingEngagement</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">clicksCount</font>
  <font style="color:#1F61A0;">commentsCount</font>
  <font style="color:#1F61A0;">complaintsCount</font>
  <font style="color:#1F61A0;">failsCount</font>
  <font style="color:#1F61A0;">favoritesCount</font>
  <font style="color:#1F61A0;">fetchedAt</font>
  <font style="color:#1F61A0;">impressionsCount</font>
  <font style="color:#1F61A0;">isCumulative</font>
  <font style="color:#1F61A0;">occurredOn</font>
  <font style="color:#1F61A0;">sendsCount</font>
  <font style="color:#1F61A0;">sharesCount</font>
  <font style="color:#1F61A0;">uniqueClicksCount</font>
  <font style="color:#1F61A0;">uniqueViewsCount</font>
  <font style="color:#1F61A0;">unsubscribesCount</font>
  <font style="color:#1F61A0;">utcOffset</font>
  <font style="color:#1F61A0;">viewsCount</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

<font style="color:#8B2BB9;">"occurredOn"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>

Arguments

MarketingEngagementInput fields

• adSpend ([MoneyInput](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyinput))
  The total ad spend for the day, if the marketing event is a paid ad with a daily spend.
• clicksCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of clicks on the marketing event for the day.
• commentsCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of comments for the day.
• complaintsCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of complaints for the day.
• failsCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of fails for the day.
• favoritesCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of favorites for the day.
• fetchedAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  The date time at which the data was fetched.
• impressionsCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of impressions for the day.
• isCumulative ([Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the engagements are reported as lifetime values rather than daily totals.
• occurredOn ([Date!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#date-2021-01)) REQUIRED
  The date that these engagements occurred on.
• sendsCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of sends for the day.
• sharesCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of shares for the day.
• uniqueClicksCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of unique clicks for the day.
• uniqueViewsCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of unique views for the day.
• unsubscribesCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of unsubscribes for the day.
• utcOffset ([UtcOffset](https://shopify.dev/docs/admin-api/graphql/reference/scalar#utcoffset-2021-01))
  The UTC Offset that the app is using to determine which date to allocate spend to.
• viewsCount ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The total number of views for the day.

Return fields

• marketingEngagement ([MarketingEngagement](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/marketingengagement))
  The marketing engagement that was created.
• userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
  List of errors that occurred executing the mutation.