Sign in

v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0189430445.4 KB
Pins

Create pin

Pin a document as a result for a given search query.Pin results that are known to be a good match.

post/rest/api/v1/pin

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.

Request body

queriesstring[]

The query strings for which the pinned result will show.

documentIdstring

The document to be pinned.

Example request

{
  "audienceFilters": [
    {
      "fieldName": "type",
      "values": [
        {
          "value": "Spreadsheet",
          "relationType": "EQUALS"
        },
        {
          "value": "Presentation",
          "relationType": "EQUALS"
        }
      ]
    }
  ]
}

Response

OK

queriesstring[]

The query strings for which the pinned result will show.

idstring

The opaque id of the pin.

documentIdstring required

The document which should be a pinned result.

createTimestring date-time
updateTimestring date-time

Example response

{
  "audienceFilters": [
    {
      "fieldName": "type",
      "values": [
        {
          "value": "Spreadsheet",
          "relationType": "EQUALS"
        },
        {
          "value": "Presentation",
          "relationType": "EQUALS"
        }
      ]
    }
  ],
  "attribution": {
    "name": "George Clooney",
    "obfuscatedId": "abc123"
  },
  "updatedBy": {
    "name": "George Clooney",
    "obfuscatedId": "abc123"
  }
}