segmentMigrations

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.

Saved segment list

Arguments

savedSearchId ● String

Migration through the saved search id search segment .

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 ● [SegmentMigrationEdge!]non-null

edges list

nodes ● [SegmentMigration]

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

segment migrations

Code

query {
  segmentMigrations(first: 3, after:null,reverse:false,savedSearchId:null) {
    edges {
      cursor
      node {
        id
        savedSearchId
      }
    }
    nodes {
        id
        savedSearchId
    }
    pageInfo {
        endCursor
        hasNextPage
        hasPreviousPage
        startCursor
    }
  }
}

Response

{
	"data": {
		"segmentMigrations": {
			"edges": [
				{
					"cursor": "39C77C6A85E202FDAAB6A0D829D4F007",
					"node": {
						"id": "gid://shopline/SegmentMigration/GROUP5582449353606848831",
						"savedSearchId": "GROUP5582449353606848831"
					}
				},
				{
					"node": {
						"id": "gid://shopline/SegmentMigration/GROUP5582449353892061504",
						"savedSearchId": "GROUP5582449353892061504"
					},
					"cursor": "AF52536A1951B28A30AAE8825A2B69B9"
				},
				{
					"cursor": "E002CE0E792FBA4E98672D39851FDFD6",
					"node": {
						"id": "gid://shopline/SegmentMigration/GROUP5582449354143719745",
						"savedSearchId": "GROUP5582449354143719745"
					}
				}
			],
			"nodes": [
				{
					"id": "gid://shopline/SegmentMigration/GROUP5582449353606848831",
					"savedSearchId": "GROUP5582449353606848831"
				},
				{
					"savedSearchId": "GROUP5582449353892061504",
					"id": "gid://shopline/SegmentMigration/GROUP5582449353892061504"
				},
				{
					"id": "gid://shopline/SegmentMigration/GROUP5582449354143719745",
					"savedSearchId": "GROUP5582449354143719745"
				}
			],
			"pageInfo": {
				"hasPreviousPage": false,
				"startCursor": "39C77C6A85E202FDAAB6A0D829D4F007",
				"endCursor": "E002CE0E792FBA4E98672D39851FDFD6",
				"hasNextPage": true
			}
		}
	}
}

Was this article helpful to you?

SHOPLINE

Legal