Skip to main content
Anchor to SegmentConnection

SegmentConnection

connection

An auto-generated type for paginating through multiple Segments.

Anchor to Queries with this connectionQueries with this connection

Anchor to segmentssegments
•query

Returns a paginated list of Segment objects for the shop. Segments are dynamic groups of customers that meet specific criteria defined through ShopifyQL queries. You can filter segments by search query and sort them by creation date or other criteria.

The query supports standard pagination arguments and returns a SegmentConnection containing segment details including names, creation dates, and the query definitions that determine segment membership.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•SegmentSortKeys
Default:CREATION_DATE

Sort the underlying list by the given key.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to name
•string
Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[SegmentEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•[Segment!]!
non-null

A list of nodes that are contained in SegmentEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?