CollectionSortKeys

Version 2019-04

The set of valid sort keys for the collections query.

Show definition
"""
The set of valid sort keys for the collections query.
"""
enum CollectionSortKeys {
  """
  Sort by the `id` value.
  """
  ID
  """
  During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
  results by relevance to the search term(s). When no search query is specified, this sort key is not
  deterministic and should not be used.
  """
  RELEVANCE
  """
  Sort by the `title` value.
  """
  TITLE
  """
  Sort by the `updated_at` value.
  """
  UPDATED_AT
}

Values

ID

Sort by the id value.

RELEVANCE

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE

Sort by the title value.

UPDATED_AT

Sort by the updated_at value.

Version 2019-07

The set of valid sort keys for the collections query.

Show definition
"""
The set of valid sort keys for the collections query.
"""
enum CollectionSortKeys {
  """
  Sort by the `id` value.
  """
  ID
  """
  During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
  results by relevance to the search term(s). When no search query is specified, this sort key is not
  deterministic and should not be used.
  """
  RELEVANCE
  """
  Sort by the `title` value.
  """
  TITLE
  """
  Sort by the `updated_at` value.
  """
  UPDATED_AT
}

Values

ID

Sort by the id value.

RELEVANCE

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE

Sort by the title value.

UPDATED_AT

Sort by the updated_at value.

Version 2019-10 (Latest)

The set of valid sort keys for the collections query.

Show definition
"""
The set of valid sort keys for the collections query.
"""
enum CollectionSortKeys {
  """
  Sort by the `id` value.
  """
  ID
  """
  During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
  results by relevance to the search term(s). When no search query is specified, this sort key is not
  deterministic and should not be used.
  """
  RELEVANCE
  """
  Sort by the `title` value.
  """
  TITLE
  """
  Sort by the `updated_at` value.
  """
  UPDATED_AT
}

Values

ID

Sort by the id value.

RELEVANCE

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE

Sort by the title value.

UPDATED_AT

Sort by the updated_at value.

Version 2020-01 (Release candidate)

The set of valid sort keys for the collections query.

Show definition
"""
The set of valid sort keys for the collections query.
"""
enum CollectionSortKeys {
  """
  Sort by the `id` value.
  """
  ID
  """
  During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the
  results by relevance to the search term(s). When no search query is specified, this sort key is not
  deterministic and should not be used.
  """
  RELEVANCE
  """
  Sort by the `title` value.
  """
  TITLE
  """
  Sort by the `updated_at` value.
  """
  UPDATED_AT
}

Values

ID

Sort by the id value.

RELEVANCE

During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

TITLE

Sort by the title value.

UPDATED_AT

Sort by the updated_at value.

Sign up for a Partner account to get started.

Sign up