Skip to main content
Required scopes: marketing_automations_read, marketing_automations_write
Analytics for this marketing automation, grouped by what is being measured.
Which trigger family this marketing automation belongs to.
The channels this automation’s steps send on, in the order the automations page shows them. Empty when it has no send step.
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.
Whether this is one of Redo’s default automations or the store’s own.
When the current version was published. Null while it has only ever been a draft.
Boolean!
required
True when this is the store’s own return-tracking automation for a trigger Redo has a default for. While it exists the default is hidden; deleting it brings the default back. Always false while returns are off.
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.
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.
required
When the automation was last updated.