Search GraphQL API¶
API under active development
Introspection may show fields or types that this reference does not document. Use this documentation to identify officially supported fields and types.
Run QL searches and retrieve their results through GraphQL.
See the guide for a narrative walkthrough of this API.
This is a GraphQL API: every request is a POST carrying a query (or mutation) document, rather than one endpoint per operation. See the guide above for the request shape and authentication.
Queries¶
- search
Retrieve search information and its current state. - searchResults
Reads results from a completed search or search partition.
Mutations¶
- createSearch
Create and execute a new search. - getOrCreateSearch
Create and execute a new search if a matching one doesn't exist. Otherwise, retrieve search information and its current state. Searches are matched on their input data, with queries compared for equivalency via their canonical structured representations, not byte-wise textual representations.
Types¶
BaseTypeCreateSearchInputHostnameMappingInt64LogicalTypeMapPartitionStatusPartitionsSuccessSearchExecutionStatusSearchOutcomeSearchPartitionSearchPartitionErrorSearchResultFieldSearchResultPageSearchResultSubTotalSearchResultTotalSearchResultTotalsSearchResultValuesSearchV2FTimeURN