customers_read
The marketing automation the decision belongs to, if any.
Show fields
Show fields
Analytics for this marketing automation, grouped by what is being measured.
Show fields
Show fields
Email and SMS performance: 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, Commerce Agent steps included. Each order is credited to the last marketing or Commerce Agent message before it, so a later message from outside the automation takes the credit.Requires:
marketing_automations_analytics_readShow fields
Show fields
Arguments
Deprecated. How many days after a message an order still counts toward it, 1-30, in place of the store’s own windows. (Deprecated)
Report only messages to this audience, and the orders and revenue credited to them. Omit it for both. Credit is assigned across both audiences first, so the two add up to the unsplit figures.
delivered, failures and unsubscribes aren’t recorded per audience: deliveries and failures count toward SUBSCRIBERS, and unsubscribes reports the whole send’s. Rates divided by delivered are therefore not comparable between the two audiences.Last day to report on, inclusive, in the store’s timezone. The range may span at most 400 days.
Per-step performance: what each step sent, how shoppers engaged and replied, and the orders and revenue credited to it. Credit is the same as
messaging’s, split by the step whose message won, so don’t add the two together; credit to a message with no step isn’t listed here. Lists only steps with activity in the range.Requires: marketing_automations_analytics_readShow fields
Show fields
Arguments
Deprecated. How many days after a message an order still counts toward it, 1-30, in place of the store’s own windows. (Deprecated)
Report only messages to this audience, and the orders and revenue credited to them. Omit it for both. Credit is assigned across both audiences first, so the two add up to the unsplit figures.
delivered, failures and unsubscribes aren’t recorded per audience: deliveries and failures count toward SUBSCRIBERS, and unsubscribes reports the whole send’s. Rates divided by delivered are therefore not comparable between the two audiences.Last day to report on, inclusive, in the store’s timezone. The range may span at most 400 days.
The automation’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
When the current version was published. Null while it has only ever been a draft.
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.The campaign the decision belongs to, if any.
Show fields
Show fields
Analytics for this campaign, grouped by what is being measured.
Show fields
Show fields
Email and SMS performance: what was sent, how it was engaged with, and the orders and revenue attributed to it. Each order is credited to the last marketing or Commerce Agent message before it, Commerce Agent replies to the campaign included, so a later message from outside the campaign takes the credit.Requires:
campaigns_analytics_readShow fields
Show fields
Arguments
Deprecated. How many days after a message an order still counts toward it, 1-30, in place of the store’s own windows. (Deprecated)
Report only messages to this audience, and the orders and revenue credited to them. Omit it for both. Credit is assigned across both audiences first, so the two add up to the unsplit figures.
delivered, failures and unsubscribes aren’t recorded per audience: deliveries and failures count toward SUBSCRIBERS, and unsubscribes reports the whole send’s. Rates divided by delivered are therefore not comparable between the two audiences.Last day to report on, inclusive, in the store’s timezone. The range may span at most 400 days.
When the merchant canceled the campaign, if they did.
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
The share of recipients this variant was sent to. A campaign with a single variant weights it 1.
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.
The segments held out of this campaign.Requires:
segments_readShow fields
Show fields
Dynamic segment condition tree. Null for static and persona segments.
When the member counts were last recalculated. They are not live.
The segment’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
When the campaign failed to send, if it did.
Follow-up email configuration when one was enabled.
Show fields
Show fields
Engagement window, in days, used to pick recipients.
The From mailbox chosen for this campaign. Null when the store default should be used, and for SMS.Requires:
campaigns_readThe campaign’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
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.
IANA time zone the merchant picked when scheduling a single UTC instant. Null for drafts and local-time sends.
IANA time zone used when a recipient has no time zone, for local-time sends. Null when
scheduledAt is set.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.The segments this campaign was sent to.Requires:
segments_readShow fields
Show fields
Dynamic segment condition tree. Null for static and persona segments.
When the member counts were last recalculated. They are not live.
The segment’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
When the campaign finished sending. Null until it has finished.
The SMS content this campaign sends, oldest arm first. Empty for email campaigns.
Show fields
Show fields
The share of recipients this variant was sent to. A campaign with a single variant weights it 1.
The content this variant sent. Null when the template has since been deleted.Requires:
marketing_templates_readTags 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.
The channel of the message decided on. Null when the decision wasn’t about one channel.
The customer record Redo used. Null when Redo decided from a phone number or email alone.
Show fields
Show fields
Merchant-defined custom field values, keyed by each field’s name. Null when the customer has no custom fields set.
The customer’s legacy identifier (the source Mongo ObjectId), accepted anywhere an
id is.The customer’s current location, if known.
Show fields
Show fields
The help desk tickets this customer is the primary contact on any thread of, newest first. Every ticket whose
customer is this customer is here.Requires: support_tickets_readShow fields
Show fields
ArgumentsFields
Forward pagination: returns the first N tickets (max 100, default 25). Use with
after; mutually exclusive with last/before.Backward pagination: returns the last N tickets (max 100, default 25). Use with
before; mutually exclusive with first/after.When the campaign or automation had last been edited as of this decision, so you can tell which version decided. Null when unknown.
The shopper’s identifiers the decision used, like
email:jane@example.com or phoneNumber:+15555550100.The facts the decision used, like the quiet hours window. Their shape depends on the reason.