| Field | Type | Required | Description | Example |
|---|---|---|---|---|
queries |
List<String> | ➖ | The query strings for which the pinned result will show. | |
audienceFilters |
List<FacetFilter> | ➖ | Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search. | |
id |
Optional<String> | ➖ | The opaque id of the pin. | |
documentId |
String | ✔️ | The document which should be a pinned result. | |
attribution |
Optional<Person> | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
updatedBy |
Optional<Person> | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
createTime |
OffsetDateTime | ➖ | N/A | |
updateTime |
OffsetDateTime | ➖ | N/A |