Indexing API
- Documents
- Permissions
- Troubleshooting
- Datasources
- Authentication
- People
- Shortcuts
Client API
- Activity
- Announcements
- Answers
- Authentication
- Calendar
- Chat
- Agents
- Collections
- Displayable Lists
- Documents
- Images
- Insights
- Messages
- Pins
- Search
- Entities
- Shortcuts
- Summarize
- Tools
- User
- Verification
Actions API
- Authentication
- Setup
Search
Feed of documents and events
Search
Feed of documents and events
The personalized feed/home includes different types of contents including suggestions, recents, calendar events and many more.
curl --request POST \
--url https://{domain}-be.glean.com/rest/api/v1/feed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"categories": [
"DOCUMENT_SUGGESTION"
],
"requestOptions": {
"resultSize": 123,
"timezoneOffset": 123,
"categoryToResultSize": {},
"datasourceFilter": [
"<string>"
],
"chatZeroStateSuggestionOptions": {
"applicationId": "<string>"
}
},
"timeoutMillis": 5000,
"sessionInfo": {
"sessionTrackingToken": "<string>",
"tabId": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"lastQuery": "<string>"
}
}'{
"experimentIds": [
123
],
"trackingToken": "<string>",
"serverTimestamp": 123,
"results": [
{
"category": "DOCUMENT_SUGGESTION",
"primaryEntry": {
"entryId": "<string>",
"title": "<string>",
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"uiConfig": {
"format": "LIST",
"additionalFlags": {
"showNewIndicator": true
}
},
"justificationType": "FREQUENTLY_ACCESSED",
"justification": "<string>",
"trackingToken": "<string>",
"viewUrl": "<string>",
"document": {
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
},
"event": {
"time": {
"start": "<string>",
"end": "<string>"
},
"eventType": "DEFAULT",
"id": "<string>",
"url": "<string>",
"attendees": {
"people": [
{
"isOrganizer": true,
"isInGroup": true,
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"groupAttendees": [
{}
],
"responseStatus": "ACCEPTED"
}
],
"isLimit": true,
"total": 123,
"numAccepted": 123,
"numDeclined": 123,
"numNoResponse": 123,
"numTentative": 123
},
"location": "<string>",
"conferenceData": {
"provider": "ZOOM",
"uri": "<string>",
"source": "NATIVE_CONFERENCE"
},
"description": "<string>",
"datasource": "<string>",
"hasTranscript": true,
"classifications": [
{
"name": "External Event",
"strategies": [
"customerCard"
]
}
],
"generatedAttachments": [
{
"strategyName": "customerCard",
"documents": [
{
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
}
],
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"customer": {
"id": "<string>",
"domains": [
"<string>"
],
"company": {
"name": "<string>",
"profileUrl": "<string>",
"websiteUrls": [
"<string>"
],
"logoUrl": "<string>",
"location": "New York City",
"phone": "<string>",
"fax": "<string>",
"industry": "Finances",
"annualRevenue": 123,
"numberOfEmployees": 123,
"stockSymbol": "<string>",
"foundedDate": "2023-12-25",
"about": "Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
},
"documentCounts": {},
"poc": [
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
],
"metadata": {
"datasourceId": "<string>",
"customData": {}
},
"mergedCustomers": [
{}
],
"startDate": "2023-12-25",
"contractAnnualRevenue": 123,
"notes": "CIO is interested in trying out the product."
},
"externalLinks": [
{
"name": "<string>",
"url": "<string>",
"iconConfig": {
"color": "#343CED",
"key": "person_icon",
"iconType": "GLYPH",
"name": "user"
}
}
],
"content": [
{
"displayHeader": "Action Items",
"content": "You said you'd send over the design document after the meeting."
}
]
}
]
},
"announcement": {
"draftId": 342
},
"collection": {
"name": "<string>",
"description": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"icon": "<string>",
"adminLocked": true,
"parentId": 123,
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"allowedDatasource": "<string>",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": 123,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"creator": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 123,
"childCount": 123,
"items": [
{
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
}
],
"pinMetadata": {
"existingPins": [
{
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
],
"eligiblePins": [
{
"id": 123,
"target": {
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
}
]
},
"shortcuts": [
"<string>"
],
"children": [
"<any>"
],
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collectionItem": {
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"app": {
"datasource": "<string>",
"docType": "<string>",
"mimeType": "<string>",
"iconUrl": "<string>"
},
"promptTemplate": {
"promptTemplate": {
"name": "<string>",
"template": "<string>",
"applicationId": "<string>",
"inclusions": {
"containerSpecs": [
{
"url": "<string>"
}
],
"documentSpecs": [
{
"url": "<string>"
}
],
"datasourceInstances": [
"<string>"
]
},
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": "<string>",
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTimestamp": 123,
"lastUpdateTimestamp": 123,
"lastUpdatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"trackingToken": "<string>",
"favoriteInfo": {
"ugcType": "ANNOUNCEMENTS_TYPE",
"id": "<string>",
"count": 123,
"favoritedByUser": true
},
"runCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
},
"workflow": {
"workflow": {
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"name": "<string>",
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTimestamp": 123,
"lastUpdateTimestamp": 123,
"lastUpdatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"id": "<string>"
}
},
"activities": [
{
"actor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"timestamp": 123,
"action": "ADD",
"aggregateVisitCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
}
],
"documentVisitorCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
},
"secondaryEntries": [
{
"entryId": "<string>",
"title": "<string>",
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"uiConfig": {
"format": "LIST",
"additionalFlags": {
"showNewIndicator": true
}
},
"justificationType": "FREQUENTLY_ACCESSED",
"justification": "<string>",
"trackingToken": "<string>",
"viewUrl": "<string>",
"document": {
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
},
"event": {
"time": {
"start": "<string>",
"end": "<string>"
},
"eventType": "DEFAULT",
"id": "<string>",
"url": "<string>",
"attendees": {
"people": [
{
"isOrganizer": true,
"isInGroup": true,
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"groupAttendees": [
{}
],
"responseStatus": "ACCEPTED"
}
],
"isLimit": true,
"total": 123,
"numAccepted": 123,
"numDeclined": 123,
"numNoResponse": 123,
"numTentative": 123
},
"location": "<string>",
"conferenceData": {
"provider": "ZOOM",
"uri": "<string>",
"source": "NATIVE_CONFERENCE"
},
"description": "<string>",
"datasource": "<string>",
"hasTranscript": true,
"classifications": [
{
"name": "External Event",
"strategies": [
"customerCard"
]
}
],
"generatedAttachments": [
{
"strategyName": "customerCard",
"documents": [
{
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
}
],
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"customer": {
"id": "<string>",
"domains": [
"<string>"
],
"company": {
"name": "<string>",
"profileUrl": "<string>",
"websiteUrls": [
"<string>"
],
"logoUrl": "<string>",
"location": "New York City",
"phone": "<string>",
"fax": "<string>",
"industry": "Finances",
"annualRevenue": 123,
"numberOfEmployees": 123,
"stockSymbol": "<string>",
"foundedDate": "2023-12-25",
"about": "Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
},
"documentCounts": {},
"poc": [
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
],
"metadata": {
"datasourceId": "<string>",
"customData": {}
},
"mergedCustomers": [
{}
],
"startDate": "2023-12-25",
"contractAnnualRevenue": 123,
"notes": "CIO is interested in trying out the product."
},
"externalLinks": [
{
"name": "<string>",
"url": "<string>",
"iconConfig": {
"color": "#343CED",
"key": "person_icon",
"iconType": "GLYPH",
"name": "user"
}
}
],
"content": [
{
"displayHeader": "Action Items",
"content": "You said you'd send over the design document after the meeting."
}
]
}
]
},
"announcement": {
"draftId": 342
},
"collection": {
"name": "<string>",
"description": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"icon": "<string>",
"adminLocked": true,
"parentId": 123,
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"allowedDatasource": "<string>",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": 123,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"creator": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 123,
"childCount": 123,
"items": [
{
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
}
],
"pinMetadata": {
"existingPins": [
{
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
],
"eligiblePins": [
{
"id": 123,
"target": {
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
}
]
},
"shortcuts": [
"<string>"
],
"children": [
"<any>"
],
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collectionItem": {
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"app": {
"datasource": "<string>",
"docType": "<string>",
"mimeType": "<string>",
"iconUrl": "<string>"
},
"promptTemplate": {
"promptTemplate": {
"name": "<string>",
"template": "<string>",
"applicationId": "<string>",
"inclusions": {
"containerSpecs": [
{
"url": "<string>"
}
],
"documentSpecs": [
{
"url": "<string>"
}
],
"datasourceInstances": [
"<string>"
]
},
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": "<string>",
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTimestamp": 123,
"lastUpdateTimestamp": 123,
"lastUpdatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"trackingToken": "<string>",
"favoriteInfo": {
"ugcType": "ANNOUNCEMENTS_TYPE",
"id": "<string>",
"count": 123,
"favoritedByUser": true
},
"runCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
},
"workflow": {
"workflow": {
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"name": "<string>",
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTimestamp": 123,
"lastUpdateTimestamp": 123,
"lastUpdatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"id": "<string>"
}
},
"activities": [
{
"actor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"timestamp": 123,
"action": "ADD",
"aggregateVisitCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
}
],
"documentVisitorCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
}
],
"rank": 123
}
],
"facetResults": {},
"mentionsTimeWindowInHours": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).
Auth type being used to access the endpoint (should be non-empty only for global tokens).
Body
application/json
Includes request params, client data and more for making user's feed.
Categories of content requested. An allowlist gives flexibility to request content separately or together.
Available options:
DOCUMENT_SUGGESTION, DOCUMENT_SUGGESTION_SCENARIO, TRENDING_DOCUMENT, VERIFICATION_REMINDER, EVENT, ANNOUNCEMENT, MENTION, DATASOURCE_AFFINITY, RECENT, COMPANY_RESOURCE, EXPERIMENTAL, PEOPLE_CELEBRATIONS, DISPLAYABLE_LIST, SOCIAL_LINK, EXTERNAL_TASKS, ZERO_STATE_CHAT_SUGGESTION, ZERO_STATE_CHAT_TOOL_SUGGESTION, ZERO_STATE_WORKFLOW_CREATED_BY_ME, ZERO_STATE_WORKFLOW_FAVORITES, ZERO_STATE_WORKFLOW_POPULAR, ZERO_STATE_WORKFLOW_SUGGESTION Number of results asked in response. If a result is a collection, counts as one.
The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Datasources for which content should be included. Empty is for all.
Timeout in milliseconds for the request. A 408 error will be returned if handling the request takes longer.
Example:
5000
A unique token for this session. A new session (and token) is created when the user issues a request from a new tab or when our server hasn't seen activity for more than 10 minutes from a tab.
A unique id for all requests a user makes from a given tab, no matter how far apart. A new tab id is only generated when a user issues a request from a new tab.
The last time the server saw this token.
The last query seen by the server.
Response
200
application/json
OK
Server unix timestamp (in seconds since epoch UTC).
An opaque token that represents this particular feed response.
Category of the result, one of the requested categories in incoming request.
Available options:
DOCUMENT_SUGGESTION, DOCUMENT_SUGGESTION_SCENARIO, TRENDING_DOCUMENT, USE_CASE, VERIFICATION_REMINDER, EVENT, ANNOUNCEMENT, MENTION, DATASOURCE_AFFINITY, RECENT, COMPANY_RESOURCE, EXPERIMENTAL, PEOPLE_CELEBRATIONS, SOCIAL_LINK, EXTERNAL_TASKS, DISPLAYABLE_LIST, ZERO_STATE_CHAT_SUGGESTION, ZERO_STATE_CHAT_TOOL_SUGGESTION, ZERO_STATE_WORKFLOW_CREATED_BY_ME, ZERO_STATE_WORKFLOW_FAVORITES, ZERO_STATE_WORKFLOW_POPULAR, ZERO_STATE_WORKFLOW_SUGGESTION Title for the result. Can be document title, event title and so on.
optional ID associated with a single feed entry (displayable_list_id)
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
How this document relates to the including entity.
Available options:
ATTACHMENT, CANONICAL, CASE, CONTACT, CONVERSATION_MESSAGES, EXPERT, FROM, HIGHLIGHT, OPPORTUNITY, RECENT, SOURCE, TICKET, TRANSCRIPT, WITH Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers)
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
A truncated list of documents with this relation. TO BE DEPRECATED.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
Available options:
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE Example:
"FULL_TIME"
The first name of the person
The last name of the person
Job title.
Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
An organizational unit where everyone has a similar task, e.g. Engineering.
Info about the employee's team(s).
Use id if you index teams via Glean, and use name and externalLink if you want to use your own team pages
The number of people in this person's department.
The user's primary email address
Additional email addresses of this user beyond the primary, if any.
User facing string representing the person's location.
Detailed location with information about country, state, city etc.
Link to a customer's internal profile page. This is set to '#' when no link is desired.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager.
Phone number as a number string.
The timezone of the person. E.g. "Pacific Daylight Time".
The offset of the person's timezone in seconds from UTC.
The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
The original photo URL of the person's avatar before any edits they made are applied
The URL of the person's banner photo.
The date when the employee started.
If a former employee, the last date of employment.
Short biography or mission statement of the employee.
She/her, He/his or other pronoun.
The total recursive size of the people reporting to this person, or 1
The total number of people who directly report to this person, or 0
The preferred name of the person, or a nickname.
List of social network profiles.
List of profiles this user has in different datasources / tools that they use.
List of people and distances to those people from this person. Optionally with metadata.
Information regarding the invite status of a person.
Whether the user has signed into Glean at least once.
The last time the user has used the Glean extension in ISO 8601 format.
Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes.
User customizable fields for additional people information.
The logging id of the person used in scrubbed logs, tracking GA metrics.
Percentage of the company that started strictly after this person. Between [0,100).
Intervals of busy time for this person, along with the type of event they're busy with.
A generic, light-weight calendar event.
flag settings to indicate user profile settings for certain items
The badges that a user has earned over their lifetime.
Displays a user's accomplishment or milestone
Whether this person is a "root" node in their organization's hierarchy.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
UI configurations for each item of the list
show a "New" pill next to the item
defines how to render this particular displayable list card
Available options:
LIST Type of the justification.
Available options:
FREQUENTLY_ACCESSED, RECENTLY_ACCESSED, TRENDING_DOCUMENT, VERIFICATION_REMINDER, SUGGESTED_DOCUMENT, EMPTY_STATE_SUGGESTION, FRECENCY_SCORED, SERVER_GENERATED, USE_CASE, UPDATE_SINCE_LAST_VIEW, RECENTLY_STARTED, EVENT, USER_MENTION, ANNOUNCEMENT, EXTERNAL_ANNOUNCEMENT, POPULARITY_BASED_TRENDING, COMPANY_RESOURCE, EVENT_DOCUMENT_FROM_CONTENT, EVENT_DOCUMENT_FROM_SEARCH, VISIT_AFFINITY_SCORED, SUGGESTED_APP, SUGGESTED_PERSON, ACTIVITY_HIGHLIGHT, SAVED_SEARCH, SUGGESTED_CHANNEL, PEOPLE_CELEBRATIONS, SOCIAL_LINK, ZERO_STATE_CHAT_SUGGESTION, ZERO_STATE_CHAT_TOOL_SUGGESTION, ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION, ZERO_STATE_STATIC_WORKFLOW_SUGGESTION, ZERO_STATE_AGENT_SUGGESTION Server side generated justification string if server provides one.
An opaque token that represents this particular feed entry in this particular response. To be used for /feedback reporting.
View URL for the entry if based on links that are not documents in Glean.
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The plaintext content of the document.
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The title of the document.
A permalink for the document.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The title of the document.
A permalink for the document.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
The title of the document.
A permalink for the document.
The datasource instance from which the document was extracted.
The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId
The Glean Document ID of the container. Uniquely identifies the container.
The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive.
The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container
The index-wide unique identifier.
A unique identifier used to represent the document in any logging or feedback requests in place of documentId.
Hash of the Glean Document ID.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of people mentioned in the document.
The level of visibility of the document as understood by our system.
Available options:
PRIVATE, SPECIFIC_PEOPLE_AND_GROUPS, DOMAIN_LINK, DOMAIN_VISIBLE, PUBLIC_LINK, PUBLIC_VISIBLE A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are components.)
The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix).
The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource.
A list of stars associated with this result. "Pin" is an older name.
The document priority. Interpretation is datasource specific.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of tags for the document. Interpretation is datasource specific.
A list of collections that the document belongs to.
The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
A list of shortcuts of which destination URL is for the document.
For file datasources like onedrive/github etc this has the path to the file
Custom fields specific to individual datasources
The document's document_category(.proto).
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A thumbnail image representing this document.
A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
A generic, light-weight calendar event.
The calendar event id
A permalink for this calendar event
The nature of the event, for example "out of office".
Available options:
DEFAULT, OUT_OF_OFFICE Full details of some of the attendees of this event
Whether the total count of the people returned is at the retrieval limit.
Total number of attendees in this event.
Total number of attendees who have accepted this event.
Total number of attendees who have declined this event.
Total number of attendees who have not responded to this event.
Total number of attendees who have responded tentatively (i.e. responded maybe) to this event.
The location that this event is taking place at.
Available options:
ZOOM, HANGOUTS A permalink for the conference.
Available options:
NATIVE_CONFERENCE, LOCATION, DESCRIPTION The HTML description of the event.
The app or other repository type from which the event was extracted
The event has a transcript associated with it enabling features like summarization
A generated classification of a given event.
The name for a generated classification of an event.
Available options:
External Event The name of method used to surface relevant data for a given calendar event.
Available options:
customerCard, news, call, email, meetingNotes, linkedIn, relevantDocuments, chatFollowUps, conversations These are attachments that aren't natively present on the event, and have been smartly suggested.
The name of method used to surface relevant data for a given calendar event.
Available options:
customerCard, news, call, email, meetingNotes, linkedIn, relevantDocuments, chatFollowUps, conversations Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of links to external sources outside of Glean.
The display configuration for a link.
Content that has been generated or extrapolated from the documents present in the document field.
The opaque id of the announcement.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Server Unix timestamp of the creation time (in seconds since epoch UTC).
Server Unix timestamp of the last update time (in seconds since epoch UTC).
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The source document if the announcement is created from one.
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The title of the document.
A permalink for the document.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
Whether or not the announcement is published.
The date and time at which the announcement becomes active.
The date and time at which the announcement expires.
The headline of the announcement.
Example:
"From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light."
An array of objects each of which contains either a string or a link which optionally corresponds to a document.
An emoji used to indicate the nature of the announcement.
Optional variant of thumbnail cropped for header background.
Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search.
Example:
"owner"
Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet.
Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet.
Example:
"Spreadsheet"
The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread).
Whether or not to hide an author attribution.
This determines whether this is a Social Feed post or a regular announcement.
Available options:
MAIN, SOCIAL_FEED This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site.
Available options:
TEXT, LINK Used by the Social Feed to pin posts to the front of the feed.
URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED".
The opaque id of the associated draft.
Example:
{ "draftId": 342 }
The unique ID of the Collection.
The unique name of the Collection.
A brief summary of the Collection's contents.
The emoji icon of this Collection.
Indicates whether edits are allowed for everyone or only admins.
The parent of this Collection, or 0 if it's a top-level Collection.
The datasource type this Collection can hold.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
The number of children Collections. Separated from the actual children so we can grab the count without children.
The items in this Collection.
The Collection ID of the Collection that this CollectionItem belongs in.
Available options:
DOCUMENT, TEXT, URL, COLLECTION If this CollectionItem is indexed, the Glean Document ID of that document.
The URL of this CollectionItem.
Unique identifier for the item within the Collection it belongs to.
The person who added this Collection item.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Unix timestamp for when the item was first added (in seconds since epoch UTC).
The Document this CollectionItem corresponds to (omitted if item is a non-indexed URL).
The Shortcut this CollectionItem corresponds to (only included if item URL is for a Go Link).
The Collection this CollectionItem corresponds to (only included if item type is COLLECTION).
The optional name of the Collection item.
A helpful description of why this CollectionItem is in the Collection that it's in.
The emoji icon for this CollectionItem. Only used for Text type items.
Metadata having what categories this Collection is pinned to and the eligible categories to pin to
List of targets this Collection is pinned to.
List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection.
The names of the shortcuts (Go Links) that point to this Collection.
The children Collections of this Collection.
The unique ID of the Collection.
The unique name of the Collection.
A brief summary of the Collection's contents.
The emoji icon of this Collection.
Indicates whether edits are allowed for everyone or only admins.
The parent of this Collection, or 0 if it's a top-level Collection.
The datasource type this Collection can hold.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
The number of children Collections. Separated from the actual children so we can grab the count without children.
The items in this Collection.
Metadata having what categories this Collection is pinned to and the eligible categories to pin to
The names of the shortcuts (Go Links) that point to this Collection.
The children Collections of this Collection.
A list of user roles for the Collection.
A list of added user roles for the Collection.
A list of removed user roles for the Collection.
Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
The permissions the current viewer has with respect to a particular object.
A list of user roles for the Collection.
A user's role with respect to a specific document.
Available options:
OWNER, VIEWER, ANSWER_MODERATOR, EDITOR, VERIFIER The document spec of the object this role originates from. The object this role is included with will usually have the same information as this document spec, but if the role is inherited, then the document spec refers to the parent document that the role came from.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of added user roles for the Collection.
A user's role with respect to a specific document.
Available options:
OWNER, VIEWER, ANSWER_MODERATOR, EDITOR, VERIFIER The document spec of the object this role originates from. The object this role is included with will usually have the same information as this document spec, but if the role is inherited, then the document spec refers to the parent document that the role came from.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of removed user roles for the Collection.
A user's role with respect to a specific document.
Available options:
OWNER, VIEWER, ANSWER_MODERATOR, EDITOR, VERIFIER The document spec of the object this role originates from. The object this role is included with will usually have the same information as this document spec, but if the role is inherited, then the document spec refers to the parent document that the role came from.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
Example:
"owner"
Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet.
Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet.
Example:
"Spreadsheet"
The Collection ID of the Collection that this CollectionItem belongs in.
Available options:
DOCUMENT, TEXT, URL, COLLECTION If this CollectionItem is indexed, the Glean Document ID of that document.
The URL of this CollectionItem.
Unique identifier for the item within the Collection it belongs to.
The person who added this Collection item.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Unix timestamp for when the item was first added (in seconds since epoch UTC).
The Document this CollectionItem corresponds to (omitted if item is a non-indexed URL).
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The title of the document.
A permalink for the document.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
The Shortcut this CollectionItem corresponds to (only included if item URL is for a Go Link).
Link text following go/ prefix as entered by the user.
canonical link text following go/ prefix where hyphen/underscore is removed.
Title for the Go Link
A list of user roles for the Go Link.
The opaque id of the user generated content.
Destination URL for the shortcut.
Glean Document ID for the URL, if known.
A short, plain text blurb to help people understand the intent of the shortcut.
Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only.
For variable shortcuts, contains the URL template; note, destinationUrl contains default URL.
A list of user roles added for the Shortcut.
A list of user roles removed for the Shortcut.
The permissions the current viewer has with respect to a particular object.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The time the shortcut was created in ISO format (ISO 8601).
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The time the shortcut was updated in ISO format (ISO 8601).
Document that corresponds to the destination URL, if applicable.
The URL from which the user is then redirected to the destination URL. Full replacement for https://go/<inputAlias>.
The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts.
Indicates whether a shortcut is native or external.
The URL using which the user can access the edit page of the shortcut.
The Collection this CollectionItem corresponds to (only included if item type is COLLECTION).
The unique ID of the Collection.
The unique name of the Collection.
A brief summary of the Collection's contents.
The emoji icon of this Collection.
Indicates whether edits are allowed for everyone or only admins.
The parent of this Collection, or 0 if it's a top-level Collection.
The datasource type this Collection can hold.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
The number of children Collections. Separated from the actual children so we can grab the count without children.
The items in this Collection.
Metadata having what categories this Collection is pinned to and the eligible categories to pin to
The names of the shortcuts (Go Links) that point to this Collection.
The children Collections of this Collection.
A list of user roles for the Collection.
A list of added user roles for the Collection.
A list of removed user roles for the Collection.
Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
The permissions the current viewer has with respect to a particular object.
The optional name of the Collection item.
A helpful description of why this CollectionItem is in the Collection that it's in.
The emoji icon for this CollectionItem. Only used for Text type items.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
How this document relates to the including entity.
Available options:
ATTACHMENT, CANONICAL, CASE, CONTACT, CONVERSATION_MESSAGES, EXPERT, FROM, HIGHLIGHT, OPPORTUNITY, RECENT, SOURCE, TICKET, TRANSCRIPT, WITH Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers)
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
A truncated list of documents with this relation. TO BE DEPRECATED.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
Available options:
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE Example:
"FULL_TIME"
The first name of the person
The last name of the person
Job title.
Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
An organizational unit where everyone has a similar task, e.g. Engineering.
Info about the employee's team(s).
Use id if you index teams via Glean, and use name and externalLink if you want to use your own team pages
The number of people in this person's department.
The user's primary email address
Additional email addresses of this user beyond the primary, if any.
User facing string representing the person's location.
Detailed location with information about country, state, city etc.
Link to a customer's internal profile page. This is set to '#' when no link is desired.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager.
Phone number as a number string.
The timezone of the person. E.g. "Pacific Daylight Time".
The offset of the person's timezone in seconds from UTC.
The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
The original photo URL of the person's avatar before any edits they made are applied
The URL of the person's banner photo.
The date when the employee started.
If a former employee, the last date of employment.
Short biography or mission statement of the employee.
She/her, He/his or other pronoun.
The total recursive size of the people reporting to this person, or 1
The total number of people who directly report to this person, or 0
The preferred name of the person, or a nickname.
List of social network profiles.
List of profiles this user has in different datasources / tools that they use.
List of people and distances to those people from this person. Optionally with metadata.
Information regarding the invite status of a person.
Whether the user has signed into Glean at least once.
The last time the user has used the Glean extension in ISO 8601 format.
Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes.
User customizable fields for additional people information.
The logging id of the person used in scrubbed logs, tracking GA metrics.
Percentage of the company that started strictly after this person. Between [0,100).
Intervals of busy time for this person, along with the type of event they're busy with.
A generic, light-weight calendar event.
flag settings to indicate user profile settings for certain items
The badges that a user has earned over their lifetime.
Displays a user's accomplishment or milestone
Whether this person is a "root" node in their organization's hierarchy.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The app or other repository type this represents
The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
Mimetype is used to differentiate between sub applications from a datasource (e.g. Sheets, Docs from Gdrive)
If there is available icon URL.
The actual template string.
Opaque id for this prompt template
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Server Unix timestamp of the creation time.
Server Unix timestamp of the last update time.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of roles for this prompt template explicitly granted.
The user-given identifier for this prompt template.
The Application Id the prompt template should be created under. Empty for default assistant.
A list of filters which only allows the prompt template to access certain content.
A list of added user roles for the Workflow.
A list of removed user roles for the Workflow.
The permissions the current viewer has with respect to a particular object.
An opaque token that represents this prompt template
Available options:
ANNOUNCEMENTS_TYPE, ANSWERS_TYPE, COLLECTIONS_TYPE, SHORTCUTS_TYPE, WORKFLOWS_TYPE, PROMPT_TEMPLATES_TYPE Opaque id of the UGC.
Number of users this object has been favorited by.
If the requesting user has favorited this object.
This tracks how many times this prompt template was run. If user runs a prompt template after modifying the original one, it still counts as a run for the original template.
The counter value
The unit of organization over which we did the count aggregation, e.g. org (department) or company
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Server Unix timestamp of the creation time.
Server Unix timestamp of the last update time.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The ID of the workflow.
The permissions the current viewer has with respect to a particular object.
The name of the workflow.
List of activity where each activity has user, action, timestamp.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Unix timestamp of the activity (in seconds since epoch UTC).
The action for the activity
Available options:
ADD, ADD_REMINDER, CLICK, COMMENT, DELETE, DISMISS, EDIT, MENTION, MOVE, OTHER, RESTORE, UNKNOWN, VERIFY, VIEW The counter value
The unit of organization over which we did the count aggregation, e.g. org (department) or company
The counter value
DEPRECATED - The number of days from now in the past to define upper boundary of time period.
DEPRECATED - The number of days from now in the past to define lower boundary of time period.
The unit of organization over which we did the count aggregation, e.g. org (department) or company
Secondary entries for the result e.g. suggested docs for the calendar, carousel.
Title for the result. Can be document title, event title and so on.
optional ID associated with a single feed entry (displayable_list_id)
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
How this document relates to the including entity.
Available options:
ATTACHMENT, CANONICAL, CASE, CONTACT, CONVERSATION_MESSAGES, EXPERT, FROM, HIGHLIGHT, OPPORTUNITY, RECENT, SOURCE, TICKET, TRANSCRIPT, WITH Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers)
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
A truncated list of documents with this relation. TO BE DEPRECATED.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
Available options:
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE Example:
"FULL_TIME"
The first name of the person
The last name of the person
Job title.
Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
An organizational unit where everyone has a similar task, e.g. Engineering.
Info about the employee's team(s).
Use id if you index teams via Glean, and use name and externalLink if you want to use your own team pages
The number of people in this person's department.
The user's primary email address
Additional email addresses of this user beyond the primary, if any.
User facing string representing the person's location.
Detailed location with information about country, state, city etc.
Link to a customer's internal profile page. This is set to '#' when no link is desired.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager.
Phone number as a number string.
The timezone of the person. E.g. "Pacific Daylight Time".
The offset of the person's timezone in seconds from UTC.
The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
The original photo URL of the person's avatar before any edits they made are applied
The URL of the person's banner photo.
The date when the employee started.
If a former employee, the last date of employment.
Short biography or mission statement of the employee.
She/her, He/his or other pronoun.
The total recursive size of the people reporting to this person, or 1
The total number of people who directly report to this person, or 0
The preferred name of the person, or a nickname.
List of social network profiles.
List of profiles this user has in different datasources / tools that they use.
List of people and distances to those people from this person. Optionally with metadata.
Information regarding the invite status of a person.
Whether the user has signed into Glean at least once.
The last time the user has used the Glean extension in ISO 8601 format.
Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes.
User customizable fields for additional people information.
The logging id of the person used in scrubbed logs, tracking GA metrics.
Percentage of the company that started strictly after this person. Between [0,100).
Intervals of busy time for this person, along with the type of event they're busy with.
A generic, light-weight calendar event.
flag settings to indicate user profile settings for certain items
The badges that a user has earned over their lifetime.
Displays a user's accomplishment or milestone
Whether this person is a "root" node in their organization's hierarchy.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
UI configurations for each item of the list
show a "New" pill next to the item
defines how to render this particular displayable list card
Available options:
LIST Type of the justification.
Available options:
FREQUENTLY_ACCESSED, RECENTLY_ACCESSED, TRENDING_DOCUMENT, VERIFICATION_REMINDER, SUGGESTED_DOCUMENT, EMPTY_STATE_SUGGESTION, FRECENCY_SCORED, SERVER_GENERATED, USE_CASE, UPDATE_SINCE_LAST_VIEW, RECENTLY_STARTED, EVENT, USER_MENTION, ANNOUNCEMENT, EXTERNAL_ANNOUNCEMENT, POPULARITY_BASED_TRENDING, COMPANY_RESOURCE, EVENT_DOCUMENT_FROM_CONTENT, EVENT_DOCUMENT_FROM_SEARCH, VISIT_AFFINITY_SCORED, SUGGESTED_APP, SUGGESTED_PERSON, ACTIVITY_HIGHLIGHT, SAVED_SEARCH, SUGGESTED_CHANNEL, PEOPLE_CELEBRATIONS, SOCIAL_LINK, ZERO_STATE_CHAT_SUGGESTION, ZERO_STATE_CHAT_TOOL_SUGGESTION, ZERO_STATE_PROMPT_TEMPLATE_SUGGESTION, ZERO_STATE_STATIC_WORKFLOW_SUGGESTION, ZERO_STATE_AGENT_SUGGESTION Server side generated justification string if server provides one.
An opaque token that represents this particular feed entry in this particular response. To be used for /feedback reporting.
View URL for the entry if based on links that are not documents in Glean.
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The plaintext content of the document.
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The title of the document.
A permalink for the document.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The title of the document.
A permalink for the document.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
The title of the document.
A permalink for the document.
The datasource instance from which the document was extracted.
The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId
The Glean Document ID of the container. Uniquely identifies the container.
The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive.
The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container
The index-wide unique identifier.
A unique identifier used to represent the document in any logging or feedback requests in place of documentId.
Hash of the Glean Document ID.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of people mentioned in the document.
The level of visibility of the document as understood by our system.
Available options:
PRIVATE, SPECIFIC_PEOPLE_AND_GROUPS, DOMAIN_LINK, DOMAIN_VISIBLE, PUBLIC_LINK, PUBLIC_VISIBLE A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are components.)
The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix).
The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource.
A list of stars associated with this result. "Pin" is an older name.
The document priority. Interpretation is datasource specific.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of tags for the document. Interpretation is datasource specific.
A list of collections that the document belongs to.
The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
A list of shortcuts of which destination URL is for the document.
For file datasources like onedrive/github etc this has the path to the file
Custom fields specific to individual datasources
The document's document_category(.proto).
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A thumbnail image representing this document.
A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
A generic, light-weight calendar event.
The calendar event id
A permalink for this calendar event
The nature of the event, for example "out of office".
Available options:
DEFAULT, OUT_OF_OFFICE Full details of some of the attendees of this event
Whether the total count of the people returned is at the retrieval limit.
Total number of attendees in this event.
Total number of attendees who have accepted this event.
Total number of attendees who have declined this event.
Total number of attendees who have not responded to this event.
Total number of attendees who have responded tentatively (i.e. responded maybe) to this event.
The location that this event is taking place at.
Available options:
ZOOM, HANGOUTS A permalink for the conference.
Available options:
NATIVE_CONFERENCE, LOCATION, DESCRIPTION The HTML description of the event.
The app or other repository type from which the event was extracted
The event has a transcript associated with it enabling features like summarization
A generated classification of a given event.
The name for a generated classification of an event.
Available options:
External Event The name of method used to surface relevant data for a given calendar event.
Available options:
customerCard, news, call, email, meetingNotes, linkedIn, relevantDocuments, chatFollowUps, conversations These are attachments that aren't natively present on the event, and have been smartly suggested.
The name of method used to surface relevant data for a given calendar event.
Available options:
customerCard, news, call, email, meetingNotes, linkedIn, relevantDocuments, chatFollowUps, conversations Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of links to external sources outside of Glean.
The display configuration for a link.
Content that has been generated or extrapolated from the documents present in the document field.
The opaque id of the announcement.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Server Unix timestamp of the creation time (in seconds since epoch UTC).
Server Unix timestamp of the last update time (in seconds since epoch UTC).
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The source document if the announcement is created from one.
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The title of the document.
A permalink for the document.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
Whether or not the announcement is published.
The date and time at which the announcement becomes active.
The date and time at which the announcement expires.
The headline of the announcement.
Example:
"From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light."
An array of objects each of which contains either a string or a link which optionally corresponds to a document.
An emoji used to indicate the nature of the announcement.
Optional variant of thumbnail cropped for header background.
Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search.
Example:
"owner"
Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet.
Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet.
Example:
"Spreadsheet"
The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread).
Whether or not to hide an author attribution.
This determines whether this is a Social Feed post or a regular announcement.
Available options:
MAIN, SOCIAL_FEED This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site.
Available options:
TEXT, LINK Used by the Social Feed to pin posts to the front of the feed.
URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED".
The opaque id of the associated draft.
Example:
{ "draftId": 342 }
The unique ID of the Collection.
The unique name of the Collection.
A brief summary of the Collection's contents.
The emoji icon of this Collection.
Indicates whether edits are allowed for everyone or only admins.
The parent of this Collection, or 0 if it's a top-level Collection.
The datasource type this Collection can hold.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
The number of children Collections. Separated from the actual children so we can grab the count without children.
The items in this Collection.
The Collection ID of the Collection that this CollectionItem belongs in.
Available options:
DOCUMENT, TEXT, URL, COLLECTION If this CollectionItem is indexed, the Glean Document ID of that document.
The URL of this CollectionItem.
Unique identifier for the item within the Collection it belongs to.
The person who added this Collection item.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Unix timestamp for when the item was first added (in seconds since epoch UTC).
The Document this CollectionItem corresponds to (omitted if item is a non-indexed URL).
The Shortcut this CollectionItem corresponds to (only included if item URL is for a Go Link).
The Collection this CollectionItem corresponds to (only included if item type is COLLECTION).
The optional name of the Collection item.
A helpful description of why this CollectionItem is in the Collection that it's in.
The emoji icon for this CollectionItem. Only used for Text type items.
Metadata having what categories this Collection is pinned to and the eligible categories to pin to
List of targets this Collection is pinned to.
List of targets this Collection can be pinned to, excluding the targets this Collection is already pinned to. We also include Collection ID already is pinned to each eligible target, which will be 0 if the target has no pinned Collection.
The names of the shortcuts (Go Links) that point to this Collection.
The children Collections of this Collection.
The unique ID of the Collection.
The unique name of the Collection.
A brief summary of the Collection's contents.
The emoji icon of this Collection.
Indicates whether edits are allowed for everyone or only admins.
The parent of this Collection, or 0 if it's a top-level Collection.
The datasource type this Collection can hold.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
The number of children Collections. Separated from the actual children so we can grab the count without children.
The items in this Collection.
Metadata having what categories this Collection is pinned to and the eligible categories to pin to
The names of the shortcuts (Go Links) that point to this Collection.
The children Collections of this Collection.
A list of user roles for the Collection.
A list of added user roles for the Collection.
A list of removed user roles for the Collection.
Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
The permissions the current viewer has with respect to a particular object.
A list of user roles for the Collection.
A user's role with respect to a specific document.
Available options:
OWNER, VIEWER, ANSWER_MODERATOR, EDITOR, VERIFIER The document spec of the object this role originates from. The object this role is included with will usually have the same information as this document spec, but if the role is inherited, then the document spec refers to the parent document that the role came from.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of added user roles for the Collection.
A user's role with respect to a specific document.
Available options:
OWNER, VIEWER, ANSWER_MODERATOR, EDITOR, VERIFIER The document spec of the object this role originates from. The object this role is included with will usually have the same information as this document spec, but if the role is inherited, then the document spec refers to the parent document that the role came from.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of removed user roles for the Collection.
A user's role with respect to a specific document.
Available options:
OWNER, VIEWER, ANSWER_MODERATOR, EDITOR, VERIFIER The document spec of the object this role originates from. The object this role is included with will usually have the same information as this document spec, but if the role is inherited, then the document spec refers to the parent document that the role came from.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
Example:
"owner"
Within a single FacetFilter, the values are to be treated like an OR. For example, fieldName type with values [EQUALS Presentation, EQUALS Spreadsheet] means we want to show a document if it's a Presentation OR a Spreadsheet.
Indicates the value of a facet, if any, that the given facet is grouped under. This is only used for nested facets, for example, fieldName could be owner and groupName would be Spreadsheet if showing all owners for spreadsheets as a nested facet.
Example:
"Spreadsheet"
The Collection ID of the Collection that this CollectionItem belongs in.
Available options:
DOCUMENT, TEXT, URL, COLLECTION If this CollectionItem is indexed, the Glean Document ID of that document.
The URL of this CollectionItem.
Unique identifier for the item within the Collection it belongs to.
The person who added this Collection item.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Unix timestamp for when the item was first added (in seconds since epoch UTC).
The Document this CollectionItem corresponds to (omitted if item is a non-indexed URL).
The Glean Document ID.
The app or other repository type from which the document was extracted
The source from which document content was pulled, e.g. an API crawl or browser history
Available options:
API_CRAWL, BROWSER_CRAWL, BROWSER_HISTORY, BUILTIN, FEDERATED_SEARCH, PUSH_API, WEB_CRAWL, NATIVE_HISTORY The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
The title of the document.
A permalink for the document.
Example:
{
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend", "Networking"],
"status": ["Done"],
"customData": { "someCustomField": "someCustomValue" }
}
A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page.
The Shortcut this CollectionItem corresponds to (only included if item URL is for a Go Link).
Link text following go/ prefix as entered by the user.
canonical link text following go/ prefix where hyphen/underscore is removed.
Title for the Go Link
A list of user roles for the Go Link.
The opaque id of the user generated content.
Destination URL for the shortcut.
Glean Document ID for the URL, if known.
A short, plain text blurb to help people understand the intent of the shortcut.
Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only.
For variable shortcuts, contains the URL template; note, destinationUrl contains default URL.
A list of user roles added for the Shortcut.
A list of user roles removed for the Shortcut.
The permissions the current viewer has with respect to a particular object.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The time the shortcut was created in ISO format (ISO 8601).
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The time the shortcut was updated in ISO format (ISO 8601).
Document that corresponds to the destination URL, if applicable.
The URL from which the user is then redirected to the destination URL. Full replacement for https://go/<inputAlias>.
The part of the shortcut preceding the input alias when used for showing shortcuts to users. Should end with "/". e.g. "go/" for native shortcuts.
Indicates whether a shortcut is native or external.
The URL using which the user can access the edit page of the shortcut.
The Collection this CollectionItem corresponds to (only included if item type is COLLECTION).
The unique ID of the Collection.
The unique name of the Collection.
A brief summary of the Collection's contents.
The emoji icon of this Collection.
Indicates whether edits are allowed for everyone or only admins.
The parent of this Collection, or 0 if it's a top-level Collection.
The datasource type this Collection can hold.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Collection. Separated from the actual items so we can grab the count without items.
The number of children Collections. Separated from the actual children so we can grab the count without children.
The items in this Collection.
Metadata having what categories this Collection is pinned to and the eligible categories to pin to
The names of the shortcuts (Go Links) that point to this Collection.
The children Collections of this Collection.
A list of user roles for the Collection.
A list of added user roles for the Collection.
A list of removed user roles for the Collection.
Filters which restrict who should see this Collection. Values are taken from the corresponding filters in people search.
The permissions the current viewer has with respect to a particular object.
The optional name of the Collection item.
A helpful description of why this CollectionItem is in the Collection that it's in.
The emoji icon for this CollectionItem. Only used for Text type items.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
How this document relates to the including entity.
Available options:
ATTACHMENT, CANONICAL, CASE, CONTACT, CONVERSATION_MESSAGES, EXPERT, FROM, HIGHLIGHT, OPPORTUNITY, RECENT, SOURCE, TICKET, TRANSCRIPT, WITH Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers)
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
A truncated list of documents with this relation. TO BE DEPRECATED.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
Available options:
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE Example:
"FULL_TIME"
The first name of the person
The last name of the person
Job title.
Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
An organizational unit where everyone has a similar task, e.g. Engineering.
Info about the employee's team(s).
Use id if you index teams via Glean, and use name and externalLink if you want to use your own team pages
The number of people in this person's department.
The user's primary email address
Additional email addresses of this user beyond the primary, if any.
User facing string representing the person's location.
Detailed location with information about country, state, city etc.
Link to a customer's internal profile page. This is set to '#' when no link is desired.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager.
Phone number as a number string.
The timezone of the person. E.g. "Pacific Daylight Time".
The offset of the person's timezone in seconds from UTC.
The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
The original photo URL of the person's avatar before any edits they made are applied
The URL of the person's banner photo.
The date when the employee started.
If a former employee, the last date of employment.
Short biography or mission statement of the employee.
She/her, He/his or other pronoun.
The total recursive size of the people reporting to this person, or 1
The total number of people who directly report to this person, or 0
The preferred name of the person, or a nickname.
List of social network profiles.
List of profiles this user has in different datasources / tools that they use.
List of people and distances to those people from this person. Optionally with metadata.
Information regarding the invite status of a person.
Whether the user has signed into Glean at least once.
The last time the user has used the Glean extension in ISO 8601 format.
Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes.
User customizable fields for additional people information.
The logging id of the person used in scrubbed logs, tracking GA metrics.
Percentage of the company that started strictly after this person. Between [0,100).
Intervals of busy time for this person, along with the type of event they're busy with.
A generic, light-weight calendar event.
flag settings to indicate user profile settings for certain items
The badges that a user has earned over their lifetime.
Displays a user's accomplishment or milestone
Whether this person is a "root" node in their organization's hierarchy.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The app or other repository type this represents
The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
Mimetype is used to differentiate between sub applications from a datasource (e.g. Sheets, Docs from Gdrive)
If there is available icon URL.
The actual template string.
Opaque id for this prompt template
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Server Unix timestamp of the creation time.
Server Unix timestamp of the last update time.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
A list of roles for this prompt template explicitly granted.
The user-given identifier for this prompt template.
The Application Id the prompt template should be created under. Empty for default assistant.
A list of filters which only allows the prompt template to access certain content.
A list of added user roles for the Workflow.
A list of removed user roles for the Workflow.
The permissions the current viewer has with respect to a particular object.
An opaque token that represents this prompt template
Available options:
ANNOUNCEMENTS_TYPE, ANSWERS_TYPE, COLLECTIONS_TYPE, SHORTCUTS_TYPE, WORKFLOWS_TYPE, PROMPT_TEMPLATES_TYPE Opaque id of the UGC.
Number of users this object has been favorited by.
If the requesting user has favorited this object.
This tracks how many times this prompt template was run. If user runs a prompt template after modifying the original one, it still counts as a run for the original template.
The counter value
The unit of organization over which we did the count aggregation, e.g. org (department) or company
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Server Unix timestamp of the creation time.
Server Unix timestamp of the last update time.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The ID of the workflow.
The permissions the current viewer has with respect to a particular object.
The name of the workflow.
List of activity where each activity has user, action, timestamp.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
Example:
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Unix timestamp of the activity (in seconds since epoch UTC).
The action for the activity
Available options:
ADD, ADD_REMINDER, CLICK, COMMENT, DELETE, DISMISS, EDIT, MENTION, MOVE, OTHER, RESTORE, UNKNOWN, VERIFY, VIEW The counter value
The unit of organization over which we did the count aggregation, e.g. org (department) or company
The counter value
DEPRECATED - The number of days from now in the past to define upper boundary of time period.
DEPRECATED - The number of days from now in the past to define lower boundary of time period.
The unit of organization over which we did the count aggregation, e.g. org (department) or company
Rank of the result. Rank is suggested by server. Client side rank may differ.
Map from category to the list of facets that can be used to filter the entry's content.
The source of this facet (e.g. container_name, type, last_updated_at).
Example:
"container_name"
How to display this facet. Currently supportes 'SelectSingle' and 'SelectMultiple'.
Example:
"SelectMultiple"
A list of unique buckets that exist within this result set.
Estimated number of results in this facet.
Example:
1
The datasource the value belongs to. This will be used by the all tab to show types across all datasources.
Example:
"jira"
Estimated percentage of results in this facet.
Example:
5
The value that should be set in the FacetFilter when applying this filter to a search request.
Example:
"engineering"
Example:
5
An optional user-friendly label to display in place of the facet value.
Example:
"engineering"
Defines how to render an icon
Example:
{
"color": "#343CED",
"key": "person_icon",
"iconType": "GLYPH",
"name": "user"
}
Returns true if more buckets exist than those returned. Additional buckets can be retrieve by requesting again with a higher facetBucketSize.
Example:
false
For most facets this will be the empty string, meaning the facet is high-level and applies to all documents for the datasource. When non-empty, this is used to group facets together (i.e. group facets for each doctype for a certain datasource)
Example:
"Service Cloud"
The time window (in hours) used for generating user mentions.
List of experiment ids for the corresponding request.
curl --request POST \
--url https://{domain}-be.glean.com/rest/api/v1/feed \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"categories": [
"DOCUMENT_SUGGESTION"
],
"requestOptions": {
"resultSize": 123,
"timezoneOffset": 123,
"categoryToResultSize": {},
"datasourceFilter": [
"<string>"
],
"chatZeroStateSuggestionOptions": {
"applicationId": "<string>"
}
},
"timeoutMillis": 5000,
"sessionInfo": {
"sessionTrackingToken": "<string>",
"tabId": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"lastQuery": "<string>"
}
}'{
"experimentIds": [
123
],
"trackingToken": "<string>",
"serverTimestamp": 123,
"results": [
{
"category": "DOCUMENT_SUGGESTION",
"primaryEntry": {
"entryId": "<string>",
"title": "<string>",
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"uiConfig": {
"format": "LIST",
"additionalFlags": {
"showNewIndicator": true
}
},
"justificationType": "FREQUENTLY_ACCESSED",
"justification": "<string>",
"trackingToken": "<string>",
"viewUrl": "<string>",
"document": {
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
},
"event": {
"time": {
"start": "<string>",
"end": "<string>"
},
"eventType": "DEFAULT",
"id": "<string>",
"url": "<string>",
"attendees": {
"people": [
{
"isOrganizer": true,
"isInGroup": true,
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"groupAttendees": [
{}
],
"responseStatus": "ACCEPTED"
}
],
"isLimit": true,
"total": 123,
"numAccepted": 123,
"numDeclined": 123,
"numNoResponse": 123,
"numTentative": 123
},
"location": "<string>",
"conferenceData": {
"provider": "ZOOM",
"uri": "<string>",
"source": "NATIVE_CONFERENCE"
},
"description": "<string>",
"datasource": "<string>",
"hasTranscript": true,
"classifications": [
{
"name": "External Event",
"strategies": [
"customerCard"
]
}
],
"generatedAttachments": [
{
"strategyName": "customerCard",
"documents": [
{
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
}
],
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"customer": {
"id": "<string>",
"domains": [
"<string>"
],
"company": {
"name": "<string>",
"profileUrl": "<string>",
"websiteUrls": [
"<string>"
],
"logoUrl": "<string>",
"location": "New York City",
"phone": "<string>",
"fax": "<string>",
"industry": "Finances",
"annualRevenue": 123,
"numberOfEmployees": 123,
"stockSymbol": "<string>",
"foundedDate": "2023-12-25",
"about": "Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
},
"documentCounts": {},
"poc": [
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
],
"metadata": {
"datasourceId": "<string>",
"customData": {}
},
"mergedCustomers": [
{}
],
"startDate": "2023-12-25",
"contractAnnualRevenue": 123,
"notes": "CIO is interested in trying out the product."
},
"externalLinks": [
{
"name": "<string>",
"url": "<string>",
"iconConfig": {
"color": "#343CED",
"key": "person_icon",
"iconType": "GLYPH",
"name": "user"
}
}
],
"content": [
{
"displayHeader": "Action Items",
"content": "You said you'd send over the design document after the meeting."
}
]
}
]
},
"announcement": {
"draftId": 342
},
"collection": {
"name": "<string>",
"description": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"icon": "<string>",
"adminLocked": true,
"parentId": 123,
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"allowedDatasource": "<string>",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": 123,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"creator": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 123,
"childCount": 123,
"items": [
{
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
}
],
"pinMetadata": {
"existingPins": [
{
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
],
"eligiblePins": [
{
"id": 123,
"target": {
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
}
]
},
"shortcuts": [
"<string>"
],
"children": [
"<any>"
],
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collectionItem": {
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"app": {
"datasource": "<string>",
"docType": "<string>",
"mimeType": "<string>",
"iconUrl": "<string>"
},
"promptTemplate": {
"promptTemplate": {
"name": "<string>",
"template": "<string>",
"applicationId": "<string>",
"inclusions": {
"containerSpecs": [
{
"url": "<string>"
}
],
"documentSpecs": [
{
"url": "<string>"
}
],
"datasourceInstances": [
"<string>"
]
},
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": "<string>",
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTimestamp": 123,
"lastUpdateTimestamp": 123,
"lastUpdatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"trackingToken": "<string>",
"favoriteInfo": {
"ugcType": "ANNOUNCEMENTS_TYPE",
"id": "<string>",
"count": 123,
"favoritedByUser": true
},
"runCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
},
"workflow": {
"workflow": {
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"name": "<string>",
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTimestamp": 123,
"lastUpdateTimestamp": 123,
"lastUpdatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"id": "<string>"
}
},
"activities": [
{
"actor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"timestamp": 123,
"action": "ADD",
"aggregateVisitCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
}
],
"documentVisitorCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
},
"secondaryEntries": [
{
"entryId": "<string>",
"title": "<string>",
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"uiConfig": {
"format": "LIST",
"additionalFlags": {
"showNewIndicator": true
}
},
"justificationType": "FREQUENTLY_ACCESSED",
"justification": "<string>",
"trackingToken": "<string>",
"viewUrl": "<string>",
"document": {
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
},
"event": {
"time": {
"start": "<string>",
"end": "<string>"
},
"eventType": "DEFAULT",
"id": "<string>",
"url": "<string>",
"attendees": {
"people": [
{
"isOrganizer": true,
"isInGroup": true,
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"groupAttendees": [
{}
],
"responseStatus": "ACCEPTED"
}
],
"isLimit": true,
"total": 123,
"numAccepted": 123,
"numDeclined": 123,
"numNoResponse": 123,
"numTentative": 123
},
"location": "<string>",
"conferenceData": {
"provider": "ZOOM",
"uri": "<string>",
"source": "NATIVE_CONFERENCE"
},
"description": "<string>",
"datasource": "<string>",
"hasTranscript": true,
"classifications": [
{
"name": "External Event",
"strategies": [
"customerCard"
]
}
],
"generatedAttachments": [
{
"strategyName": "customerCard",
"documents": [
{
"id": "<string>",
"datasource": "<string>",
"connectorType": "API_CRAWL",
"docType": "<string>",
"content": {
"fullTextList": [
"<string>"
]
},
"containerDocument": {},
"parentDocument": {},
"title": "<string>",
"url": "<string>",
"metadata": {
"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": [
"Backend",
"Networking"
],
"status": [
"Done"
],
"customData": {
"someCustomField": "someCustomValue"
}
},
"sections": [
{
"title": "<string>",
"url": "<string>"
}
]
}
],
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"customer": {
"id": "<string>",
"domains": [
"<string>"
],
"company": {
"name": "<string>",
"profileUrl": "<string>",
"websiteUrls": [
"<string>"
],
"logoUrl": "<string>",
"location": "New York City",
"phone": "<string>",
"fax": "<string>",
"industry": "Finances",
"annualRevenue": 123,
"numberOfEmployees": 123,
"stockSymbol": "<string>",
"foundedDate": "2023-12-25",
"about": "Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
},
"documentCounts": {},
"poc": [
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
],
"metadata": {
"datasourceId": "<string>",
"customData": {}
},
"mergedCustomers": [
{}
],
"startDate": "2023-12-25",
"contractAnnualRevenue": 123,
"notes": "CIO is interested in trying out the product."
},
"externalLinks": [
{
"name": "<string>",
"url": "<string>",
"iconConfig": {
"color": "#343CED",
"key": "person_icon",
"iconType": "GLYPH",
"name": "user"
}
}
],
"content": [
{
"displayHeader": "Action Items",
"content": "You said you'd send over the design document after the meeting."
}
]
}
]
},
"announcement": {
"draftId": 342
},
"collection": {
"name": "<string>",
"description": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"icon": "<string>",
"adminLocked": true,
"parentId": 123,
"thumbnail": {
"photoId": "<string>",
"url": "<string>"
},
"allowedDatasource": "<string>",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": 123,
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"creator": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 123,
"childCount": 123,
"items": [
{
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
}
],
"pinMetadata": {
"existingPins": [
{
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
],
"eligiblePins": [
{
"id": 123,
"target": {
"category": "COMPANY_RESOURCE",
"value": "<string>",
"target": "RESOURCE_CARD"
}
}
]
},
"shortcuts": [
"<string>"
],
"children": [
"<any>"
],
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collectionItem": {
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"collectionId": 123,
"documentId": "<string>",
"url": "<string>",
"itemId": "<string>",
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createdAt": "2023-11-07T05:31:56Z",
"document": {},
"shortcut": {
"id": 123,
"inputAlias": "<string>",
"destinationUrl": "<string>",
"destinationDocumentId": "<string>",
"description": "<string>",
"unlisted": true,
"urlTemplate": "<string>",
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2023-11-07T05:31:56Z",
"destinationDocument": {},
"intermediateUrl": "<string>",
"viewPrefix": "<string>",
"isExternal": true,
"editUrl": "<string>",
"alias": "<string>",
"title": "<string>",
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collection": "<any>",
"itemType": "DOCUMENT"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"app": {
"datasource": "<string>",
"docType": "<string>",
"mimeType": "<string>",
"iconUrl": "<string>"
},
"promptTemplate": {
"promptTemplate": {
"name": "<string>",
"template": "<string>",
"applicationId": "<string>",
"inclusions": {
"containerSpecs": [
{
"url": "<string>"
}
],
"documentSpecs": [
{
"url": "<string>"
}
],
"datasourceInstances": [
"<string>"
]
},
"addedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"removedRoles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": "<string>",
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTimestamp": 123,
"lastUpdateTimestamp": 123,
"lastUpdatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"trackingToken": "<string>",
"favoriteInfo": {
"ugcType": "ANNOUNCEMENTS_TYPE",
"id": "<string>",
"count": 123,
"favoritedByUser": true
},
"runCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
},
"workflow": {
"workflow": {
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"name": "<string>",
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTimestamp": 123,
"lastUpdateTimestamp": 123,
"lastUpdatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"id": "<string>"
}
},
"activities": [
{
"actor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"timestamp": 123,
"action": "ADD",
"aggregateVisitCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
}
],
"documentVisitorCount": {
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
}
],
"rank": 123
}
],
"facetResults": {},
"mentionsTimeWindowInHours": 123
}