customerSegmentMembers - admin-graphql - QUERY
Version: 2024-10
Description:
The list of members, such as customers, that's associated with an individual segment.
The maximum page size is 1000.
Access Scopes
Arguments
-
after:
String -
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
-
before:
String -
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
-
first:
Int -
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
-
last:
Int -
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
-
query:
String -
The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference).
-
queryId:
ID -
The ID of the segment members query.
-
reverse:
Boolean -
Reverse the order of the list. The sorting behaviour defaults to ascending order.
-
segmentId:
ID -
The ID of the segment.
-
sortKey:
String -
Sort the list by a given key.
-
timezone:
String -
The timezone that's used to interpret relative date arguments. The timezone defaults to UTC if the timezone isn't provided.
Returns
-
edges:
CustomerSegmentMemberEdge!
A list of edges.
-
pageInfo:
PageInfo!
An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.
-
statistics:
SegmentStatistics!
The statistics for a given segment.
-
totalCount:
Int!
The total number of members in a given segment.
Examples