segmentValueSuggestions - admin-graphql - QUERY

Version: 2024-10

Description:

The list of suggested values corresponding to a particular filter for a segment. A segment is a group of members, such as customers, that meet specific criteria.

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).
  • filterQueryName: String - Returns the elements of a list by filter handle.
  • first: Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
  • functionParameterQueryName: String - Returns the elements of a list by filter parameter name.
  • last: Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
  • search: String! - Returns the elements of a list by keyword or term.

Returns

  • edges: SegmentValueEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
  • nodes: SegmentValue! A list of nodes that are contained in SegmentValueEdge. 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.
  • pageInfo: PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page.

Examples