Graph search · GraphQL input

GraphSearchInput input

Graph search input parameters.

Fields

Input Field Description
orgId - OrganizationId! The Organization to search.
timeRange - DateTimeRangeInput

Optionally constrains the search by time. Null (the default) means no time constraint on objects: every object of each searched type is eligible regardless of when it was last seen. Supply a range to limit the result to objects seen within it.

  • Objects: with a range supplied, every node in the query — the root object type and each relationship target — is limited to objects seen at some point within it; an object last seen before the range is excluded. A node that pins a specific object id is exempt (that object is returned regardless of when it was last seen). With null, no such filter is applied and all objects of each type are eligible.
  • Time-series relationships (those declared with a time-series option, e.g. a device's observed network connections) are evaluated over the range: an edge is returned when it was active at some point within it. A time-series traversal always needs a bounded window, so with null it falls back to a default window of the last 30 days — even though the object search itself is unfiltered.
  • All other relationships (one-to-one, many-to-one, and non-time-series many-to-many) return current state and ignore this range entirely, regardless of whether it is supplied.

To restrict objects to those seen recently, pass an explicit range; leaving it null returns all objects.

query - GraphSearchQueryInput! The query specifying the object type, conditions, relationships, and columns to return.
first - Int Limit the search to the first N results. When null no limit is applied.
sort - GraphSearchSortInput How to order the results. Null leaves the results unsorted. Otherwise set exactly one mode on the sort: default: true to use the top-level object type's default sort, or column to sort on an explicit property path and direction.

Used by

Example

Example

{
  "orgId": "615f3b3b28284380e28a7342",
  "timeRange": DateTimeRangeInput,
  "query": GraphSearchQueryInput,
  "first": 123,
  "sort": GraphSearchSortInput
}