marketingAutomations

Required scopes: marketing_automations_read

Arguments

String

Forward pagination cursor — returns items after it. Pass an edges[].cursor or pageInfo.endCursor from a previous page.

String

Backward pagination cursor — returns items before it. Pass an edges[].cursor or pageInfo.startCursor from a previous page.

MarketingAutomationCategory

Only include marketing automations in this category.

Boolean

Only include marketing automations that are running (true) or paused (false).

Int

Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.

Int

Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.

MarketingAutomationSortKey

Which key to sort by (defaults to the first key, newest-first). Combine with reverse to flip direction.

String

Case-insensitive substring match on the marketing automation name. At most 200 characters.

Boolean

Reverses the sort direction selected by orderBy (or its default).

Returns

MarketingAutomationConnection!

required

A paginated list of MarketingAutomation items.

Show fields

[MarketingAutomationEdge!]!

required

The list of edges (each a node plus its pagination cursor).

Show fields

String!

required

Opaque cursor for this item; pass to after/before to page from here.

MarketingAutomation!

required

The item at this edge.

Show fields

MarketingAutomationAnalytics!

required

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

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.

[MarketingAutomation!]!

required

The nodes in this page, without the edge/cursor wrapper — a convenience over edges.

Show fields

MarketingAutomationAnalytics!

required

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

Show fields

MarketingAutomationMessagingAnalytics!

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.

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

DateTime!

required

When the automation was last updated.

PageInfo!

required

Pagination metadata for the current page.

Show fields

String

Cursor of the last edge in this page; pass to after to page forward.

Boolean!

required

Whether more items exist after this page (drives forward pagination with first/after).

Boolean!

required

Whether more items exist before this page (drives backward pagination with last/before).

String

Cursor of the first edge in this page; pass to before to page backward.

Example

query {
  marketingAutomations(after: "...", before: "...", category: CUSTOM_EVENT, enabled: true, first: 10, last: 10, orderBy: CREATED_AT, query: "...", reverse: true) {
    nodes {
      category
      createdAt
      description
      enabled
      id
      legacyId
      name
      publishedAt
      # ...
    }
    pageInfo { hasNextPage endCursor }
  }
}

Getting Started

Reference

marketingAutomations

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example