Graph search · GraphQL type

GraphSearchResultsPayload type

The payload returned from a graph search results query. Contains one entry per matched object; each entry is a path made up of one or more segments describing the objects traversed to reach the result.

Fields

Field Name Description
nodes - [GraphSearchResultsPath!]! The paths returned by the search. Each path corresponds to one row of the result set.
job - GraphSearchJob! The GraphSearchJob the results were read from. Always present — including when nodes is empty — so callers can inspect job state (results count, running, errors) without issuing a separate graphSearchJob query.

Related types

Example

Example

{
  "nodes": [GraphSearchResultsPath],
  "job": GraphSearchJob
}