Skip to main content

CatalogQuery

No description

CatalogQuery(
  query: String
  querySignature: String
  querySort: String
  page: Int
  queryExclusions: [String!]
  queryLimit: Int
): CatalogContent!

Directives​

complexity​

This has an additional cost of 3 points per queryLimit.

Arguments​

CatalogQuery.query ● String scalar​

CatalogQuery.querySignature ● String scalar​

CatalogQuery.querySort ● String scalar​

CatalogQuery.page ● Int scalar​

The page number to return within the collection.

CatalogQuery.queryExclusions ● [String!] list scalar​

CatalogQuery.queryLimit ● Int scalar​

Type​

CatalogContent object​

Examples​

Run in Postman

Query:​

CatalogQuery(
 $query: String,
 $querySignature: String,
 $querySort: String,
 $page: Int,
 $queryExclusions: [String!],
 $queryLimit: Int
) {
 CatalogQuery(
   query: $query,
   querySignature: $querySignature,
   querySort: $querySort,
   page: $page,
   queryExclusions: $queryExclusions,
   queryLimit: $queryLimit
 ) {
   contentItems {
     ...ContentFragment
   }
   meta {
     ...CatalogMetaFragment
   }
 }
}

Variables:​

{
 "query": "abc123",
 "querySignature": "abc123",
 "querySort": "abc123",
 "page": 678,
 "queryExclusions": [
   "abc123"
 ],
 "queryLimit": 678
}

Response:​

{
  "data": {
    "CatalogQuery": {
      "contentItems": [
        "Content"
      ],
      "meta": "CatalogMeta"
    }
  }
}