MarketingAutomation

Required scopes: marketing_automations_read, marketing_automations_write

required

Analytics for this marketing automation, grouped by what is being measured.

Show fields

required

Email and SMS performance, read from the analytics warehouse: what was sent, how it was engaged with, and the orders and revenue attributed to it. Covers messages sent by the automation’s own send steps; Recover conversations are measured separately and are not included here.Requires: marketing_automations_analytics_read

Show fields

Arguments

Int

How many days after a message an order still counts toward it, 1-30.

Date!

required

Last day to report on, inclusive, in the store’s timezone. The range may span at most 400 days.

Date!

required

First day to report on, inclusive, in the store’s timezone. Must be on or before endDate, and the range may span at most 400 days.

Fields

[MessageAnalyticsPoint!]!

required

One entry per day with activity, oldest first. Quiet days are omitted rather than reported as zero.

MessageAnalyticsTotals!

required

Totals across the whole range. A marketing automation with no activity reports zero counts and null rates.

MarketingAutomationCategory!

required

Which trigger family this marketing automation belongs to.

DateTime!

required

When the automation was created.

String

The merchant’s description of what this automation does.

Boolean!

required

Whether the automation is currently running.

ID!

required

The id of this automation.

String!

required

The automation’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.

String!

required

The merchant-facing name of the automation.

DateTime

When the current version was published. Null while it has only ever been a draft.

[MarketingAutomationStep!]!

required

The nodes that make up this automation, including graph edges as step ids. A type this API version does not model field-by-field is returned as MarketingAutomationUnknownStep.

[JSON!]!

required

steps with every field selected, as JSON: one element per step, with __typename. Null and invalid stored steps are []. Webhook header values and OAuth client secrets are omitted. Edits go through operations.

DateTime!

required

When the automation was last updated.

Getting Started

Reference

MarketingAutomation