Sign in

v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0170379386.9 KB
Search

Autocomplete

Retrieve query suggestions, operators and documents for the given partially typed query.

post/rest/api/v1/autocomplete

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Headers

X-Glean-ActAsstring email

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

X-Glean-Auth-Typestring

Auth type being used to access the endpoint (should be non-empty only for global tokens).

Request body

trackingTokenstring
querystring

Partially typed query.

datasourcesFilterstring[]

Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). Results are unfiltered if missing.

datasourcestring

Filter to only return results relevant to the given datasource.

resultTypesstring[]

Filter to only return results of the given type(s). All types may be returned if omitted.

resultSizeinteger

Maximum number of results to be returned. If no value is provided, the backend will cap at 200.

Example request

{
  "trackingToken": "trackingToken",
  "query": "what is a que",
  "datasource": "GDRIVE",
  "resultSize": 10
}

Response

OK

experimentIdsinteger[]

List of experiment ids for the corresponding request.

trackingTokenstring

An opaque token that represents this particular set of autocomplete results. To be used for /feedback reporting.

backendTimeMillisinteger

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

Example response

{
  "trackingToken": "trackingToken"
}