| Field | Type | Required | Description | Example |
|---|---|---|---|---|
queries |
List[str] | ➖ | The query strings for which the pinned result will show. | |
audience_filters |
List[models.FacetFilter] | ➖ | Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search. | |
id |
Optional[str] | ➖ | The opaque id of the pin. | |
document_id |
str | ✔️ | The document which should be a pinned result. | |
attribution |
Optional[models.Person] | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
updated_by |
Optional[models.Person] | ➖ | N/A | { "name": "George Clooney", "obfuscatedId": "abc123" } |
create_time |
date | ➖ | N/A | |
update_time |
date | ➖ | N/A | |
favorite_info |
Optional[models.FavoriteInfo] | ➖ | N/A |