segmentFilters

query

Requires read_customers access scope.

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

Segmented recommendation list

Arguments

after ● String

Returns elements following the specified cursor. The first argument must also be specified when using this argument.

before ● String

Returns elements preceding the specified cursor. The last argument must also be specified when using this argument.

first ● Int

Returns the first n elements in the list.

last ● Int

Returns the last n elements in the list.

reverse ● Boolean

Whether to reverse the order of the list.

● true: reverse

● false: do not reverse

Default value: false

Return

edges ● [SegmentFilterEdge!]non-null

edge list

nodes ● [SegmentFilter]

node list

pageInfo ● PageInfo!non-null

Information to aid in pagination.

Status and error codes

For detailed information about common codes, see Status and error codes.

Example

Segmented recommendation list

Code

query {
  segmentFilters(first: 2, after:null,reverse:false) {
    edges {
      node {
        queryName
        queryValue
      }
    }
    nodes {
        queryName
        queryValue
    }
    pageInfo {
        endCursor
        hasNextPage
        hasPreviousPage
        startCursor
    }
  }
}

Response

{
	"data": {
		"segmentFilters": {
			"edges": [
				{
					"node": {
						"queryName": "emailDomain",
						"queryValue": "{\"key\":\"emailDomain\",\"type\":0,\"operator\":\"IN\",\"value\":[],\"extInfo\":{\"operatorType\":\"EQ\",\"componentType\":\"LIST_PAGE\",\"listSource\":\"emailDomain\"}}"
					}
				},
				{
					"node": {
						"queryValue": "{\"key\":\"language\",\"type\":0,\"operator\":\"IN\",\"value\":[],\"extInfo\":{\"operatorType\":\"EQ\",\"componentType\":\"LIST\",\"listSource\":\"language\"}}",
						"queryName": "language"
					}
				}
			],
			"nodes": [
				{
					"queryName": "emailDomain",
					"queryValue": "{\"key\":\"emailDomain\",\"type\":0,\"operator\":\"IN\",\"value\":[],\"extInfo\":{\"operatorType\":\"EQ\",\"componentType\":\"LIST_PAGE\",\"listSource\":\"emailDomain\"}}"
				},
				{
					"queryName": "language",
					"queryValue": "{\"key\":\"language\",\"type\":0,\"operator\":\"IN\",\"value\":[],\"extInfo\":{\"operatorType\":\"EQ\",\"componentType\":\"LIST\",\"listSource\":\"language\"}}"
				}
			],
			"pageInfo": {
				"hasPreviousPage": false,
				"startCursor": "39C77C6A85E202FDAAB6A0D829D4F007",
				"endCursor": "AF52536A1951B28A30AAE8825A2B69B9",
				"hasNextPage": true
			}
		}
	}
}

Was this article helpful to you?

SHOPLINE

Legal