v68

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

Search

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

post/rest/api/v1/search

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

timestampstring date-time

The ISO 8601 timestamp associated with the client request.

trackingTokenstring

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

pageSizeinteger

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.

maxSnippetSizeinteger

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

querystring required

The search terms.

cursorstring

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

resultTabIdsstring[]

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.

timeoutMillisinteger

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

disableSpellcheckboolean

Whether or not to disable spellcheck.

Example request

{
  "trackingToken": "trackingToken",
  "query": "vacation policy",
  "pageSize": 10,
  "requestOptions": {
    "facetFilters": [
      {
        "fieldName": "type",
        "values": [
          {
            "value": "article",
            "relationType": "EQUALS"
          },
          {
            "value": "document",
            "relationType": "EQUALS"
          }
        ]
      },
      {
        "fieldName": "department",
        "values": [
          {
            "value": "engineering",
            "relationType": "EQUALS"
          }
        ]
      }
    ]
  }
}

Response

trackingTokenstring

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

requestIDstring

A platform-generated request ID to correlate backend logs.

backendTimeMillisinteger

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

experimentIdsinteger[]

List of experiment ids for the corresponding request.

resultTabIdsstring[]

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

cursorstring

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

hasMoreResultsboolean

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

Example response

{
  "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",
      "url": "https://www.example.com/"
    },
    {
      "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",
      "url": "https://www.example.com/"
    }
  ],
  "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"
      ]
    }
  ]
}