Search

post/search

Retrieve results from the index for the given query and filters.

SecurityBearerAuth
Request
header Parameters
X-Scio-Actas
string <email>

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

Request Body schema: application/json

Search request

query
required
string

The search terms.

cursor
string

Pagination cursor. A previously received opaque token representing the position in the overall results at which to start.

disableSpellcheck
boolean

Whether or not to disable spellcheck.

object (SearchRequestInputDetails)
maxSnippetSize
integer

Hint to the server about how many characters long a snippet may be. Server may return less or more.

pageSize
integer

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.

Array of objects (Person)

People associated with the search request. Hints to the server to fetch additional information for these people. Note that in this request, an email may be used as a person's obfuscatedId value.

object (SearchRequestOptions)
resultTabIds
Array of strings

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.

object (SessionInfo)
object (Document)
timeoutMillis
integer

Timeout in milliseconds for the request. A 408 error will be returned if handling the request takes longer.

timestamp
string <date-time>

The ISO 8601 timestamp associated with the client request.

trackingToken
string

A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs.

Responses
200

OK

Response Schema: application/json
backendTimeMillis
integer <int64>

Time in milliseconds the backend took to respond to the request.

cursor
string

Cursor that indicates the start of the next page of results. To be passed in "more" requests for this query.

object (ErrorInfo)
experimentIds
Array of integers <int64>

List of experiment ids for the corresponding request.

Array of objects (FacetResult)
object (GeneratedQna)
hasMoreResults
boolean

Whether more results are available. Use cursor to retrieve them.

object (SearchResponseMetadata)
requestID
string

A platform-generated request ID to correlate backend logs.

Array of objects (SearchResult)
object (ResultsDescription)
resultTabIds
Array of strings

The unique IDs of the result tabs to which this response belongs.

Array of objects (ResultTab)

All result tabs available for the current query. Populated if QUERY_METADATA is specified in the request.

Array of objects (FacetFilter)

The actual applied facet filters based on the operators and facetFilters in the query. Useful for mapping typed operators to visual facets.

object (SessionInfo)
Array of objects (StructuredResult)
trackingToken
string

A token that should be passed for additional requests related to this request (such as more results requests).

400

Invalid request

401

Not Authorized

403

Forbidden

408

Request Timeout

422

Invalid Query

429

Too Many Requests

Request samples
application/json
{
  • "trackingToken": "trackingToken",
  • "query": "vacation policy",
  • "pageSize": 10,
  • "requestOptions": {
    • "facetFilters": [
      • {
        • "fieldName": "type",
        • "values": [
          • "article",
          • "document"
          ]
        },
      • {
        • "fieldName": "department",
        • "values": [
          • "engineering"
          ]
        }
      ]
    }
}
Response samples
application/json
{
  • "trackingToken": "trackingToken",
  • "suggestedSpellCorrectedQuery": "suggestedSpellCorrectedQuery",
  • "hasMoreResults": true,
  • "errorInfo": {
    • "errorMessages": [
      • {
        • "source": "gmail",
        • "errorMessage": "invalid token"
        },
      • {
        • "source": "slack",
        • "errorMessage": "expired token"
        }
      ]
    },
  • "requestID": "5e345ae500ff0befa2b9d1a3ba0001737e7363696f312d323535323137000171756572792d656e64706f696e743a323032303031333074313830343032000100",
  • "results": [
    • {
      • "snippets": [
        • {
          • "snippet": "snippet",
          • "mimeType": "mimeType"
          }
        ],
      • "metadata": {
        • "container": "container",
        • "createTime": "2000-01-23T04:56:07.000Z",
        • "datasource": "datasource",
        • "author": {
          • "name": "name"
          },
        • "documentId": "documentId",
        • "updateTime": "2000-01-23T04:56:07.000Z",
        • "mimeType": "mimeType",
        • "objectType": "objectType"
        },
      • "title": "title",
      },
    • {
      • "snippets": [
        • {
          • "snippet": "snippet",
          • "mimeType": "mimeType"
          }
        ],
      • "metadata": {
        • "container": "container",
        • "createTime": "2000-01-23T04:56:07.000Z",
        • "datasource": "datasource",
        • "author": {
          • "name": "name"
          },
        • "documentId": "documentId",
        • "updateTime": "2000-01-23T04:56:07.000Z",
        • "mimeType": "mimeType",
        • "objectType": "objectType"
        },
      • "title": "title",
      }
    ],
  • "facetResults": [
    • {
      • "buckets": [
        • {
          • "percentage": 5,
          • "count": 1,
          • "value": {
            • "stringValue": "stringValue",
            • "integerValue": 5
            }
          },
        • {
          • "percentage": 5,
          • "count": 1,
          • "value": {
            • "stringValue": "stringValue",
            • "integerValue": 5
            }
          }
        ],
      • "sourceName": "sourceName",
      • "operatorName": "operatorName",
      • "objectType": "objectType"
      },
    • {
      • "buckets": [
        • {
          • "percentage": 5,
          • "count": 1,
          • "value": {
            • "stringValue": "stringValue",
            • "integerValue": 5
            }
          },
        • {
          • "percentage": 5,
          • "count": 1,
          • "value": {
            • "stringValue": "stringValue",
            • "integerValue": 5
            }
          }
        ],
      • "sourceName": "sourceName",
      • "operatorName": "operatorName",
      • "objectType": "objectType"
      }
    ],
  • "rewrittenQuery": "rewrittenQuery",
  • "rewrittenFacetFilters": [
    • {
      • "fieldName": "fieldName",
      • "values": [
        • "fieldValues",
        • "fieldValues"
        ]
      },
    • {
      • "fieldName": "fieldName",
      • "values": [
        • "fieldValues",
        • "fieldValues"
        ]
      }
    ]
}