commerceAgentConversations

Required scopes: commerce_agent_conversations_read

Arguments

String

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

CommerceAgentAuthor

Only include conversations this source started.

Only include conversations with outreach from this marketing automation: its id, or its legacyId.

String

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

Only include conversations with outreach from this campaign: its id, or its legacyId from an earlier version of the Redo API.

Int

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

CommerceAgentGenerationMode

Only include conversations with outreach written this way.

Int

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

DateTime

Only include conversations whose latest message is at or after this ISO-8601 instant.

DateTime

Only include conversations whose latest message is at or before this ISO-8601 instant.

CommerceAgentConversationSortKey

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

String

Match shopper name, email, phone, or message text. At most 200 characters.

Boolean

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

CommerceAgentConversationSentiment

Only include conversations whose latest analysis found this sentiment.

CommerceAgentConversationStatus

Only include conversations in this reply state.

String

Only include conversations with outreach from this trigger key.

Returns

CommerceAgentConversationConnection!

required

A paginated list of CommerceAgentConversation items.

Show fields

[CommerceAgentConversationEdge!]!

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.

CommerceAgentConversation!

required

The item at this edge.

Show fields

CommerceAgentChannel!

required

The channel the conversation takes place on.

DateTime!

required

When the conversation started.

Int!

required

How many messages the shopper sent.

ID!

required

The id of this conversation.

DateTime

When the shopper last wrote. Null if they never have.

DateTime

When Commerce Agent or the merchant’s team last wrote, including internal notes. Null if neither has.

DateTime

The latest message from either side, including internal notes. LAST_RESPONSE_AT sorts by this.

Int!

required

How many messages Commerce Agent, the merchant’s team, auto-replies, and chat flows sent, including internal notes, as the conversations page counts them.

CommerceAgentMessageConnection!

required

The conversation’s messages, oldest first. Internal notes are left out.Requires: commerce_agent_conversations_read

Show fields

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.

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.

CommerceAgentOutreachConnection!

required

The outbound messages that started or continued this conversation, oldest first, with the campaign or automation behind each.Requires: commerce_agent_conversations_read

Show fields

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.

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.

DateTime!

required

When the conversation was last updated.

[CommerceAgentConversation!]!

required

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

Show fields

CommerceAgentChannel!

required

The channel the conversation takes place on.

DateTime!

required

When the conversation started.

Int!

required

How many messages the shopper sent.

ID!

required

The id of this conversation.

DateTime

When the shopper last wrote. Null if they never have.

DateTime

When Commerce Agent or the merchant’s team last wrote, including internal notes. Null if neither has.

DateTime

The latest message from either side, including internal notes. LAST_RESPONSE_AT sorts by this.

Int!

required

How many messages Commerce Agent, the merchant’s team, auto-replies, and chat flows sent, including internal notes, as the conversations page counts them.

CommerceAgentMessageConnection!

required

The conversation’s messages, oldest first. Internal notes are left out.Requires: commerce_agent_conversations_read

Show fields

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.

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.

Fields

[CommerceAgentMessageEdge!]!

required

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

[CommerceAgentMessage!]!

required

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

PageInfo!

required

Pagination metadata for the current page.

CommerceAgentOutreachConnection!

required

The outbound messages that started or continued this conversation, oldest first, with the campaign or automation behind each.Requires: commerce_agent_conversations_read

Show fields

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.

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.

Fields

[CommerceAgentOutreachEdge!]!

required

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

[CommerceAgentOutreach!]!

required

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

PageInfo!

required

Pagination metadata for the current page.

DateTime!

required

When the conversation 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 {
  commerceAgentConversations(after: "...", author: CAMPAIGN, automation: "...", before: "...", campaign: "...", first: 10, generationMode: AI, last: 10, lastResponseAfter: "...", lastResponseBefore: "...", orderBy: CREATED_AT, query: "...", reverse: true, sentiment: MIXED, status: AWAITING, trigger: "...") {
    nodes {
      channel
      createdAt
      customerMessageCount
      id
      lastCustomerMessageAt
      lastMerchantMessageAt
      lastResponseAt
      merchantMessageCount
      # ...
    }
    pageInfo { hasNextPage endCursor }
  }
}

Getting Started

Guides

Reference

commerceAgentConversations

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example