API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

marketingEngagementCreate mutation

Version unstable

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-07

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-04

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-01 (Unsupported)

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Creates a new marketing event engagement for a marketing activity.

Required access

write_marketing_events access scope.

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.


Arguments

Argument Description
marketingActivityId ( ID! ) required

The id of marketing activity.
marketingEngagement ( MarketingEngagementInput! ) required

The marketing engagement's attributes.

MarketingEngagementInput fields

  • adSpend (MoneyInput)

    The total ad spend for the day, if the marketing event is a paid ad with a daily spend.

  • clicksCount (Int)

    The total number of clicks on the marketing event for the day.

  • commentsCount (Int)

    The total number of comments for the day.

  • complaintsCount (Int)

    The total number of complaints for the day.

  • failsCount (Int)

    The total number of fails for the day.

  • favoritesCount (Int)

    The total number of favorites for the day.

  • fetchedAt (DateTime)

    The date time at which the data was fetched.

  • impressionsCount (Int)

    The total number of impressions for the day.

  • isCumulative (Boolean)

    Whether the engagements are reported as lifetime values rather than daily totals.

  • occurredOn (Date!) Required

    The date that these engagements occurred on.

  • sendsCount (Int)

    The total number of sends for the day.

  • sharesCount (Int)

    The total number of shares for the day.

  • uniqueClicksCount (Int)

    The total number of unique clicks for the day.

  • uniqueViewsCount (Int)

    The total number of unique views for the day.

  • unsubscribesCount (Int)

    The total number of unsubscribes for the day.

  • utcOffset (UtcOffset)

    The UTC Offset that the app is using to determine which date to allocate spend to.

  • viewsCount (Int)

    The total number of views for the day.

Return fields

  • marketingEngagement (MarketingEngagement)

    The marketing engagement that was created.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.