Graph search · GraphQL input

GraphSearchFastInput input

Input parameters for graphSearchFast, the synchronous form of graphSearch.

Takes the same organization, time range, and query as GraphSearchInput, minus the sort — the fast form returns results in the order the search pipeline produced them. To sort, page, or fetch more than one page, start the search with graphSearch and read its job with graphSearchResults.

Fields

Input Field Description
orgId - OrganizationId! The Organization to search.
timeRange - DateTimeRangeInput Optionally constrains the search by time, exactly as GraphSearchInput.timeRange does: null leaves objects unfiltered by time, time-series relationships fall back to the last 30 days, and all other relationships return current state.
query - GraphSearchQueryInput! The query specifying the object type, conditions, relationships, and columns to return.
first - Int!

The maximum number of results to return. Must be greater than zero — this is both the search's result cap and the size of the single page returned, so there is no unlimited form.

A request above the server's cap (100,000, and configurable lower) returns that many rows instead of failing. The cap also stops the search itself, so searchJob.resultsCount saturates at it rather than reporting how many objects matched — treat a full page as "there may be more". For a larger result set, run graphSearch and page it with graphSearchResults.

Example

Example

{
  "orgId": "615f3b3b28284380e28a7342",
  "timeRange": DateTimeRangeInput,
  "query": GraphSearchQueryInput,
  "first": 987
}