| Field | Type | Required | Description | Example |
|---|---|---|---|---|
timestamp |
OffsetDateTime | ➖ | The ISO 8601 timestamp associated with the client request. | |
trackingToken |
Optional<String> | ➖ | A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs. | |
sessionInfo |
Optional<SessionInfo> | ➖ | N/A | |
sourceDocument |
Optional<Document> | ➖ | N/A | |
pageSize |
Optional<Long> | ➖ | Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize. | 100 |
maxSnippetSize |
Optional<Long> | ➖ | Hint to the server about how many characters long a snippet may be. Server may return less or more. | 400 |
query |
String | ✔️ | The search terms. | vacation policy |
cursor |
Optional<String> | ➖ | Pagination cursor. A previously received opaque token representing the position in the overall results at which to start. | |
resultTabIds |
List<String> | ➖ | The unique IDs of the result tabs for which to fetch results. This will have precedence over datasource filters if both are specified and in conflict. | |
inputDetails |
Optional<SearchRequestInputDetails> | ➖ | N/A | { "hasCopyPaste": true } |
requestOptions |
Optional<SearchRequestOptions> | ➖ | N/A | { "datasourceFilter": "JIRA", "datasourcesFilter": [ "JIRA" ], "queryOverridesFacetFilters": true, "facetFilters": [ { "fieldName": "fieldName", "values": [ "fieldValues", "fieldValues" ] }, { "fieldName": "fieldName", "values": [ "fieldValues", "fieldValues" ] } ] } |
timeoutMillis |
Optional<Long> | ➖ | Timeout in milliseconds for the request. A 408 error will be returned if handling the request takes longer. |
5000 |
disableSpellcheck |
Optional<Boolean> | ➖ | Whether or not to disable spellcheck. |