Graph search · GraphQL query

graphParseQuery query

Parses a graph search where-clause string into its abstract syntax tree without running a search, validating it against the object type's search query schema — for presenting a query in a user interface. See GraphParseQueryPayload.

Response

Returns a GraphParseQueryPayload!

Arguments

Name Description
input - GraphParseQueryInput! The parse input: the object type scoping the query and the query string.

Example

Query

query graphParseQuery($input: GraphParseQueryInput!) {
  graphParseQuery(input: $input) {
    parsedQuery {
      ast {
        ...SearchQueryExpressionFragment
      }
      prefixesFound
      hasUnscopedTopLevelExp
    }
  }
}

Variables

{"input": GraphParseQueryInput}

Response

{
  "data": {
    "graphParseQuery": {
      "parsedQuery": SearchParseQueryResult
    }
  }
}