Graph search · GraphQL type

GraphSearchInputPayload type

The parameters that were submitted to start a graph search.

Fields

Field Name Description
orgId - OrganizationId! The Organization to search.
timeRange - DateTimeRange

The time range that constrained the search, or null when the caller supplied none. It affects which graph objects and which time-series relationships were returned, and has no effect on non-time-series relationships (see GraphSearchInput for the full semantics):

  • Objects: when a range was supplied, every node in the query — the root object type and each relationship target — was limited to objects seen at some point within it (a node pinned to a specific object id is exempt). When null, objects were not filtered by time: all objects of each type were eligible.
  • Time-series relationships (those declared with a time-series option) were evaluated over the range: an edge is returned when it was active at some point within it. When null, they were evaluated over the default window of the last 30 days — a time-series traversal always uses a bounded window.
  • All other relationships (one-to-one, many-to-one, and non-time-series many-to-many) return current state and ignore this range.
query - GraphSearchQueryInputPayload! The query specifying the object type, conditions, relationships, and columns to return.
tz - Timezone! The timezone used when evaluating time-based filters and formatting time values in the search.
first - Int Limit the search to the first N results. When null no limit is applied.
sort - GraphSearchSortInputPayload How the results are ordered. Null means unsorted; otherwise default reports whether the object type's default sort was requested and column carries the concrete column the results are sorted on.

Used by

Example

Example

{
  "orgId": "615f3b3b28284380e28a7342",
  "timeRange": DateTimeRange,
  "query": GraphSearchQueryInputPayload,
  "tz": "Europe/Amsterdam",
  "first": 987,
  "sort": GraphSearchSortInputPayload
}