The marketing automation that sent this outreach, if one did.Requires:
marketing_automations_readShow fields
Show fields
required
Analytics for this marketing automation, grouped by what is being measured.
Show fields
Show fields
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_readShow fields
Show fields
Arguments
Int
How many days after a message an order still counts toward it, 1-30.
Last day to report on, inclusive, in the store’s timezone. The range may span at most 400 days.
required
Which trigger family this marketing automation belongs to.
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.
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.
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.Which kind of automation sent it. Null unless
origin is AUTOMATION.The campaign that sent this outreach, if one did.Requires:
campaigns_readShow fields
Show fields
required
Analytics for this campaign, grouped by what is being measured.
Show fields
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.Requires:
campaigns_analytics_readShow fields
Show fields
Arguments
Int
How many days after a message an order still counts toward it, 1-30.
Last day to report on, inclusive, in the store’s timezone. The range may span at most 400 days.
required
The channel this campaign sends on.
required
The email content this campaign sends, oldest arm first. A campaign that is not split-testing has exactly one entry; there is no separate
subject on the campaign because a split test has more than one.Show fields
Show fields
Float!
required
The share of recipients this variant was sent to. A campaign with a single variant weights it 1.
Int!
required
This variant’s position within the campaign, starting at 0. Stable, so it names an arm of a split test across reports.
The content this variant sent. Null when the template has since been deleted.Requires:
marketing_templates_readWhy the campaign failed, when it did.
required
The segments held out of this campaign.Requires:
segments_readShow fields
Show fields
String
The merchant’s description of who this segment is for.
Int
Members subscribed to email marketing as of
countsRefreshedAt.ID!
required
The id of this segment.
String!
required
The segment’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
Int
Customers in the segment as of
countsRefreshedAt. Null until it has first been counted.String!
required
The merchant-facing name of the segment.
Int
Members subscribed to SMS marketing as of
countsRefreshedAt.required
How membership of this segment is determined.
Follow-up email configuration when one was enabled.
Show fields
Show fields
Float
Delay after the original send before the follow-up goes out.
Boolean!
required
Whether a follow-up send is configured.
Engagement window, in days, used to pick recipients.
String
Legacy Mongo ObjectId of the campaign this follow-up was created from.
String
Subject line for the follow-up email.
The From mailbox chosen for this campaign. Null when the store default should be used, and for SMS.Requires:
campaigns_readID!
required
The id of this campaign.
String!
required
The campaign’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
String!
required
The merchant-facing name of the campaign.
The Reply-To mailbox chosen for this campaign. Null when the store default should be used.Requires:
campaigns_readWhen the campaign is scheduled to start sending. Null for drafts, and for campaigns scheduled in each recipient’s local time.
String
IANA time zone the merchant picked when scheduling a single UTC instant. Null for drafts and local-time sends.
String
IANA time zone used when a recipient has no time zone, for local-time sends. Null when
scheduledAt is set.String
For campaigns scheduled in each recipient’s local time, the wall-clock time they send at, as
YYYY-MM-DDTHH:mm:ss. Null when scheduledAt is set.required
The segments this campaign was sent to.Requires:
segments_readShow fields
Show fields
String
The merchant’s description of who this segment is for.
Int
Members subscribed to email marketing as of
countsRefreshedAt.ID!
required
The id of this segment.
String!
required
The segment’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
Int
Customers in the segment as of
countsRefreshedAt. Null until it has first been counted.String!
required
The merchant-facing name of the segment.
Int
Members subscribed to SMS marketing as of
countsRefreshedAt.required
How membership of this segment is determined.
required
The SMS content this campaign sends, oldest arm first. Empty for email campaigns.
Show fields
Show fields
Float!
required
The share of recipients this variant was sent to. A campaign with a single variant weights it 1.
Int!
required
This variant’s position within the campaign, starting at 0.
The content this variant sent. Null when the template has since been deleted.Requires:
marketing_templates_readrequired
Derived lifecycle status from schedule, send, failure, and cancellation timestamps.
[String!]!
required
Tags the merchant applied to this campaign, in the order they applied them. Free-form and merchant-defined — Redo attaches no meaning to them, so they are the place a store’s own categorisation (a promotion name, a season, a product line) is kept. Empty when the campaign is untagged.
How the message was written.
What started this outreach.
Boolean!
required
Whether a person on the merchant’s team approved the message before it sent.
String
The trigger key that fired this outreach, such as a checkout abandonment event.