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
Recommend documents
Search
Recommend documents
Retrieve recommended documents for the given URL or Glean Document ID.
curl --request POST \
--url https://{domain}-be.glean.com/rest/api/v1/recommendations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"timestamp": "2023-11-07T05:31:56Z",
"trackingToken": "<string>",
"sessionInfo": {
"sessionTrackingToken": "<string>",
"tabId": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"lastQuery": "<string>"
},
"sourceDocument": {
"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>"
}
]
},
"pageSize": 100,
"maxSnippetSize": 400,
"recommendationDocumentSpec": {
"url": "<string>"
},
"requestOptions": {
"datasourceFilter": "<string>",
"datasourcesFilter": [
"<string>"
],
"facetFilterSets": [
{
"filters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
]
}
],
"context": {
"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>"
}
]
},
"resultProminence": [
"HERO"
]
}
}'{
"trackingToken": "<string>",
"sessionInfo": {
"sessionTrackingToken": "<string>",
"tabId": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"lastQuery": "<string>"
},
"results": [
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://example.com/foo/bar",
"nativeAppUrl": "slack://foo/bar",
"mustIncludeSuggestions": [
{
"missingTerm": "container",
"query": "container"
}
]
}
],
"structuredResults": [
{
"document": {},
"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."
},
"team": {
"relatedObjects": {},
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": "<string>",
"name": "<string>",
"description": "<string>",
"businessUnit": "<string>",
"department": "<string>",
"photoUrl": "<string>",
"bannerUrl": "<string>",
"externalLink": "<string>",
"members": [
{
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"relationship": "MEMBER",
"customRelationshipStr": "<string>",
"joinDate": "2023-11-07T05:31:56Z"
}
],
"memberCount": 123,
"emails": [
{
"email": "jsmith@example.com",
"type": "PRIMARY",
"isUserGenerated": true
}
],
"datasourceProfiles": [
{
"datasource": "github",
"handle": "<string>",
"url": "<string>",
"nativeAppUrl": "<string>",
"isUserGenerated": true
}
],
"datasource": "<string>",
"createdFrom": "<string>",
"lastUpdatedAt": "2023-11-07T05:31:56Z",
"status": "PROCESSED",
"canBeDeleted": true,
"loggingId": "<string>"
},
"customEntity": {
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": "<string>",
"title": "<string>",
"datasource": "<string>",
"objectType": "<string>",
"metadata": {
"customData": {}
},
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"answer": {
"id": 3,
"docId": "ANSWERS_answer_3",
"question": "Why is the sky blue?",
"questionVariations": [
"<string>"
],
"bodyText": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"boardId": 123,
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"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"
}
],
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"sourceDocumentSpec": {
"url": "<string>"
},
"sourceType": "DOCUMENT",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"combinedAnswerText": {
"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"structuredList": [
{
"link": "https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
"document": {},
"text": "Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue."
}
]
},
"likes": {
"likedBy": [
{
"user": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z"
}
],
"likedByUser": true,
"numLikes": 123
},
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"verification": {
"state": "UNVERIFIED",
"metadata": {
"lastVerifier": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"lastVerificationTs": 123,
"expirationTs": 123,
"document": {},
"reminders": [
{
"assignee": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"requestor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"remindAt": 123,
"createdAt": 123,
"reason": "<string>"
}
],
"lastReminder": {
"assignee": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"requestor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"remindAt": 123,
"createdAt": 123,
"reason": "<string>"
},
"visitorCount": [
{
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
],
"candidateVerifiers": [
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
]
}
},
"board": {
"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"
}
]
}
],
"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,
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collections": [
{
"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"
}
]
}
],
"documentCategory": "<string>",
"sourceDocument": {}
},
"extractedQnA": {
"heading": "<string>",
"question": "<string>",
"questionResult": "<any>"
},
"meeting": {
"id": "<string>",
"title": "<string>",
"description": "<string>",
"url": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"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
}
},
"app": {
"datasource": "<string>",
"docType": "<string>",
"mimeType": "<string>",
"iconUrl": "<string>"
},
"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"
}
]
},
"answerBoard": {
"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"
}
]
}
],
"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,
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"code": {
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{
"startindex": 0,
"endIndex": 5
},
{
"startIndex": 12,
"endIndex": 17
}
]
}
]
},
"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"
}
]
},
"querySuggestions": {
"suggestions": [
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
],
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
},
"relatedDocuments": [
{}
],
"relatedQuestion": {
"question": "<string>",
"answer": "<string>",
"ranges": [
{
"startIndex": 123,
"endIndex": 123,
"type": "BOLD",
"url": "<string>",
"document": {}
}
]
},
"disambiguation": {
"name": "<string>",
"id": "<string>",
"type": "PERSON"
},
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"trackingToken": "<string>",
"prominence": "HERO",
"source": "EXPERT_DETECTION"
}
],
"generatedQnaResult": {
"question": "<string>",
"answer": "<string>",
"followUpPrompts": [
"<string>"
],
"followupActions": [
{
"actionRunId": "<string>",
"actionInstanceId": "<string>",
"actionId": "<string>",
"recommendationText": "<string>",
"actionLabel": "<string>",
"userConfirmationRequired": true
}
],
"ranges": [
{
"startIndex": 123,
"endIndex": 123,
"type": "BOLD",
"url": "<string>",
"document": {}
}
],
"status": "COMPUTING",
"cursor": "<string>",
"trackingToken": "<string>"
},
"errorInfo": {
"badGmailToken": true,
"badOutlookToken": true,
"invalidOperators": [
{
"key": "<string>",
"value": "<string>"
}
],
"errorMessages": [
{
"source": "<string>",
"errorMessage": "<string>"
}
]
},
"requestID": "<string>",
"backendTimeMillis": 1100
}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
Recommendations request
Retrieve recommendations for this document. Glean Document ID is preferred over URL.
The URL of the document.
Options for adjusting the request for recommendations.
Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
Filter results to only those relevant to one or more datasources (e.g. jira, gdrive). All results are returned if missing.
A list of facet filter sets that will be OR'ed together.
Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
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.
Example:
"Spreadsheet"
Available options:
EQUALS, ID_EQUALS, LT, GT Example:
"EQUALS"
DEPRECATED - please use relationType instead
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"
Content for either a new or unindexed document, or additional content for an indexed document, which may be used to generate recommendations.
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 plaintext content of the document.
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.
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 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.
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.
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"
}
A list of people mentioned in the document.
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"
}
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 which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
The document priority. Interpretation is datasource specific.
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"
}
A list of tags for the document. Interpretation is datasource specific.
A list of collections that the document belongs to.
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 user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
The count of comments (thread replies in the case of slack).
The count of reactions on the document.
To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document.
Describes instances of someone posting a link to this document in one of our indexed datasources.
Search endpoint will only fill out numDays ago since that's all we need to display shared badge; docmetadata endpoint will fill out all the fields so that we can display shared badge tooltip
Describes the write permissions levels that a user has for a specific feature
A list of shortcuts of which destination URL is for the document.
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.
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).
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"
}
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.
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.
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 types of prominence wanted in results returned. Default is any type.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD The ISO 8601 timestamp associated with the client request.
A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs.
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.
The document from which the ResultsRequest is issued, if any.
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 plaintext content of the document.
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.
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"
}
A list of people mentioned in the document.
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"
}
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 which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
The document priority. Interpretation is datasource specific.
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"
}
A list of tags for the document. Interpretation is datasource specific.
A list of collections that the document belongs to.
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 user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
The count of comments (thread replies in the case of slack).
The count of reactions on the document.
To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document.
Describes instances of someone posting a link to this document in one of our indexed datasources.
Search endpoint will only fill out numDays ago since that's all we need to display shared badge; docmetadata endpoint will fill out all the fields so that we can display shared badge tooltip
Describes the write permissions levels that a user has for a specific feature
The counter value
The unit of organization over which we did the count aggregation, e.g. org (department) or company
A list of shortcuts of which destination URL is for the document.
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.
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).
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"
}
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.
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.
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 plaintext content of the document.
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.
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"
}
A list of people mentioned in the document.
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"
}
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 which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
The document priority. Interpretation is datasource specific.
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"
}
A list of tags for the document. Interpretation is datasource specific.
A list of collections that the document belongs to.
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 user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
The count of comments (thread replies in the case of slack).
The count of reactions on the document.
To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document.
Describes instances of someone posting a link to this document in one of our indexed datasources.
Search endpoint will only fill out numDays ago since that's all we need to display shared badge; docmetadata endpoint will fill out all the fields so that we can display shared badge tooltip
Describes the write permissions levels that a user has for a specific feature
The counter value
The unit of organization over which we did the count aggregation, e.g. org (department) or company
A list of shortcuts of which destination URL is for the document.
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.
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).
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"
}
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.
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.
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.
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 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"
}
A list of people mentioned in the document.
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"
}
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 which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. 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 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 query strings for which the pinned result will show.
The document priority. Interpretation is datasource specific.
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 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"
}
A list of tags for the document. Interpretation is datasource specific.
A list of collections that the document belongs to.
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 user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
The count of comments (thread replies in the case of slack).
The count of reactions on the document.
To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document.
The count of the reaction type on the document.
Whether the user in context reacted with this type to the document.
Describes instances of someone posting a link to this document in one of our indexed datasources.
Search endpoint will only fill out numDays ago since that's all we need to display shared badge; docmetadata endpoint will fill out all the fields so that we can display shared badge tooltip
The number of days that has passed since the share happened
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The counter value
The unit of organization over which we did the count aggregation, e.g. org (department) or company
The verification state for the document.
Available options:
UNVERIFIED, VERIFIED, DEPRECATED Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The unix timestamp of the verification (in seconds since epoch UTC).
The unix timestamp of the verification expiration if applicable (in seconds since epoch UTC).
Info about all outstanding verification reminders for the document if exists.
Number of visitors to the document during included time periods.
List of potential verifiers for the document e.g. old verifiers and/or users with view/edit permissions.
Describes the write permissions levels that a user has for a specific feature
Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
Available options:
GLOBAL, OWN True if user has create permission for this feature and scope
True if user has update permission for this feature and scope
True if user has delete permission for this feature and scope
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
A list of shortcuts of which destination URL is for the document.
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.
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"
}
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 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 user roles removed for the Shortcut.
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"
}
The permissions the current viewer has with respect to a particular object.
Describes the write permissions levels that a user has for a specific feature
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 time the shortcut was created in ISO format (ISO 8601).
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 time the shortcut was updated in ISO format (ISO 8601).
Document that corresponds to the destination URL, if applicable.
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 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.
For file datasources like onedrive/github etc this has the path to the file
Custom fields specific to individual datasources
list of strings for multi-value properties
The document's document_category(.proto).
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"
}
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.
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.
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" }
}
Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize.
Example:
100
Hint to the server about how many characters long a snippet may be. Server may return less or more.
Example:
400
Response
200
application/json
OK
A token that should be passed for additional requests related to this request (such as more results requests).
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.
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 plaintext content of the document.
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.
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 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.
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.
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"
}
A list of people mentioned in the document.
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"
}
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 which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
The document priority. Interpretation is datasource specific.
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"
}
A list of tags for the document. Interpretation is datasource specific.
A list of collections that the document belongs to.
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 user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
The count of comments (thread replies in the case of slack).
The count of reactions on the document.
To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document.
Describes instances of someone posting a link to this document in one of our indexed datasources.
Search endpoint will only fill out numDays ago since that's all we need to display shared badge; docmetadata endpoint will fill out all the fields so that we can display shared badge tooltip
Describes the write permissions levels that a user has for a specific feature
A list of shortcuts of which destination URL is for the document.
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.
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).
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"
}
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.
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.
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 deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
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.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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)
The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Name of the search provider.
URL to the provider's logo.
URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
The maximum number of FacetBuckets to return in each FacetResult.
Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery.
A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields.
Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource.
Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter
Array of hints containing which fields should be populated in the response.
Hints for the response content.
Available options:
ALL_RESULT_COUNTS, FACET_RESULTS, QUERY_METADATA, RESULTS, SPELLCHECK_METADATA The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Whether or not to disable spellcheck.
Disables automatic adjustment of the input query for spelling corrections or other reasons.
[beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions.
A list of filters which restrict the search results to only the specified content.
A list of filters specifying content to avoid getting search results from. Exclusions take precendence over inclusions and other query parameters, such as search operators and search facets.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests.
Example:
{ "hasCopyPaste": true }
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.
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 truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
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 deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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)
The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
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.
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.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result 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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
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 query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Name of the search provider.
URL to the provider's logo.
URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
The maximum number of FacetBuckets to return in each FacetResult.
Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery.
A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields.
Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource.
Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter
Array of hints containing which fields should be populated in the response.
Hints for the response content.
Available options:
ALL_RESULT_COUNTS, FACET_RESULTS, QUERY_METADATA, RESULTS, SPELLCHECK_METADATA The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Whether or not to disable spellcheck.
Disables automatic adjustment of the input query for spelling corrections or other reasons.
[beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions.
A list of filters which restrict the search results to only the specified content.
A list of filters specifying content to avoid getting search results from. Exclusions take precendence over inclusions and other query parameters, such as search operators and search facets.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. 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 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 query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
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 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"
}
Unique identifier.
Link to company's associated website domains.
A map of {string, int} pairs representing counts of each document type associated with this customer.
A list of POC for company.
A list of Customers.
The date when the interaction with customer started.
Average contract annual revenue with that customer.
User facing (potentially generated) notes about company.
Example:
"CIO is interested in trying out the product."
Unique identifier
Team name
A description of the team
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.
A link to the team's photo.
A link to the team's banner photo.
Link to a team page on the internet or your company's intranet
The members on this team
Metadata about the relationship of a person to a team.
Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team)
The emails for this team
The datasource profiles of the team
the data source of the team, e.g. GDRIVE
For teams created from docs, the doc title. Otherwise empty.
when this team was last updated.
whether this team is fully processed or there are still unprocessed operations that'll affect it
Available options:
PROCESSED, QUEUED_FOR_CREATION, QUEUED_FOR_DELETION can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot
The logging id of the team used in scrubbed logs, client analytics, and metrics.
A list of objects related to a source object.
The permissions the current viewer has with respect to a particular object.
Unique identifier.
Title or name of the custom entity.
The datasource the custom entity is from.
The type of the entity. Interpretation is specific to each datasource
A list of user roles for the custom entity explicitly granted by the owner.
The permissions the current viewer has with respect to a particular object.
The opaque ID of the Answer.
Example:
3
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The time the answer was created in ISO format (ISO 8601).
The time the answer was last updated in ISO format (ISO 8601).
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The parent board this answer is in.
The collections to which the answer belongs.
The document's document_category(.proto).
Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.
Example:
"ANSWERS_answer_3"
Example:
"Why is the sky blue?"
Additional ways of phrasing this question.
The plain text answer to the question.
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."
The parent board ID of this Answer, or 0 if it's a floating Answer.
Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search.
A list of user roles for the answer added by the owner.
A list of user roles for the answer removed by the owner.
A list of roles for this answer explicitly granted by an owner, editor, or admin.
Available options:
DOCUMENT, ASSISTANT The permissions the current viewer has with respect to a particular object.
Heading text that was matched to produce this result.
Question text that was matched to produce this result.
Example:
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://example.com/foo/bar",
"nativeAppUrl": "slack://foo/bar",
"mustIncludeSuggestions": [
{
"missingTerm": "container",
"query": "container"
}
]
}
The attendee list, including their response status
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 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 unique ID of the Answer Board.
The unique name of the Collection.
A brief summary of the Collection's contents.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items.
A list of user roles for the Answer Board.
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.
Last file match for a repo
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
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.
A list of documents related to this structured result.
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.
The text of the related question
The answer for the related question
Subsections of the answer string to which some special formatting should be applied (eg. bold)
A subsection of a given string to which some special formatting should be applied.
A disambiguation between multiple entities with the same name
Name of the ambiguous entity
The unique id of the entity in the knowledge graph
The type of entity.
Available options:
PERSON, PROJECT, CUSTOMER Any snippets associated to the populated object.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result 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 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 deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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)
The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
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.
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.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result 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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
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 query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Name of the search provider.
URL to the provider's logo.
URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
The maximum number of FacetBuckets to return in each FacetResult.
Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery.
A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields.
Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource.
Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter
Array of hints containing which fields should be populated in the response.
Hints for the response content.
Available options:
ALL_RESULT_COUNTS, FACET_RESULTS, QUERY_METADATA, RESULTS, SPELLCHECK_METADATA The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Whether or not to disable spellcheck.
Disables automatic adjustment of the input query for spelling corrections or other reasons.
[beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions.
A list of filters which restrict the search results to only the specified content.
A list of filters specifying content to avoid getting search results from. Exclusions take precendence over inclusions and other query parameters, such as search operators and search facets.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. 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 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 query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
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 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"
}
Unique identifier.
Link to company's associated website domains.
A map of {string, int} pairs representing counts of each document type associated with this customer.
A list of POC for company.
A list of Customers.
The date when the interaction with customer started.
Average contract annual revenue with that customer.
User facing (potentially generated) notes about company.
Example:
"CIO is interested in trying out the product."
Unique identifier
Team name
A description of the team
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.
A link to the team's photo.
A link to the team's banner photo.
Link to a team page on the internet or your company's intranet
The members on this team
Metadata about the relationship of a person to a team.
Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team)
The emails for this team
The datasource profiles of the team
the data source of the team, e.g. GDRIVE
For teams created from docs, the doc title. Otherwise empty.
when this team was last updated.
whether this team is fully processed or there are still unprocessed operations that'll affect it
Available options:
PROCESSED, QUEUED_FOR_CREATION, QUEUED_FOR_DELETION can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot
The logging id of the team used in scrubbed logs, client analytics, and metrics.
A list of objects related to a source object.
The permissions the current viewer has with respect to a particular object.
Unique identifier.
Title or name of the custom entity.
The datasource the custom entity is from.
The type of the entity. Interpretation is specific to each datasource
A list of user roles for the custom entity explicitly granted by the owner.
The permissions the current viewer has with respect to a particular object.
The opaque ID of the Answer.
Example:
3
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The time the answer was created in ISO format (ISO 8601).
The time the answer was last updated in ISO format (ISO 8601).
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The parent board this answer is in.
The collections to which the answer belongs.
The document's document_category(.proto).
Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.
Example:
"ANSWERS_answer_3"
Example:
"Why is the sky blue?"
Additional ways of phrasing this question.
The plain text answer to the question.
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."
The parent board ID of this Answer, or 0 if it's a floating Answer.
Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search.
A list of user roles for the answer added by the owner.
A list of user roles for the answer removed by the owner.
A list of roles for this answer explicitly granted by an owner, editor, or admin.
Available options:
DOCUMENT, ASSISTANT The permissions the current viewer has with respect to a particular object.
Heading text that was matched to produce this result.
Question text that was matched to produce this result.
Example:
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://example.com/foo/bar",
"nativeAppUrl": "slack://foo/bar",
"mustIncludeSuggestions": [
{
"missingTerm": "container",
"query": "container"
}
]
}
The attendee list, including their response status
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 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 unique ID of the Answer Board.
The unique name of the Collection.
A brief summary of the Collection's contents.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items.
A list of user roles for the Answer Board.
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.
Last file match for a repo
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
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.
A list of documents related to this structured result.
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.
The text of the related question
The answer for the related question
Subsections of the answer string to which some special formatting should be applied (eg. bold)
A subsection of a given string to which some special formatting should be applied.
A disambiguation between multiple entities with the same name
Name of the ambiguous entity
The unique id of the entity in the knowledge graph
The type of entity.
Available options:
PERSON, PROJECT, CUSTOMER Any snippets associated to the populated object.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
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 deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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)
The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
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.
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.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result 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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
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 query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Name of the search provider.
URL to the provider's logo.
URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
The maximum number of FacetBuckets to return in each FacetResult.
Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery.
A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields.
Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource.
Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter
Array of hints containing which fields should be populated in the response.
Hints for the response content.
Available options:
ALL_RESULT_COUNTS, FACET_RESULTS, QUERY_METADATA, RESULTS, SPELLCHECK_METADATA The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Whether or not to disable spellcheck.
Disables automatic adjustment of the input query for spelling corrections or other reasons.
[beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions.
A list of filters which restrict the search results to only the specified content.
A list of filters specifying content to avoid getting search results from. Exclusions take precendence over inclusions and other query parameters, such as search operators and search facets.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. 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 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 query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
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 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"
}
Unique identifier.
Link to company's associated website domains.
A map of {string, int} pairs representing counts of each document type associated with this customer.
A list of POC for company.
A list of Customers.
The date when the interaction with customer started.
Average contract annual revenue with that customer.
User facing (potentially generated) notes about company.
Example:
"CIO is interested in trying out the product."
Unique identifier
Team name
A description of the team
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.
A link to the team's photo.
A link to the team's banner photo.
Link to a team page on the internet or your company's intranet
The members on this team
Metadata about the relationship of a person to a team.
Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team)
The emails for this team
The datasource profiles of the team
the data source of the team, e.g. GDRIVE
For teams created from docs, the doc title. Otherwise empty.
when this team was last updated.
whether this team is fully processed or there are still unprocessed operations that'll affect it
Available options:
PROCESSED, QUEUED_FOR_CREATION, QUEUED_FOR_DELETION can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot
The logging id of the team used in scrubbed logs, client analytics, and metrics.
A list of objects related to a source object.
The permissions the current viewer has with respect to a particular object.
Unique identifier.
Title or name of the custom entity.
The datasource the custom entity is from.
The type of the entity. Interpretation is specific to each datasource
A list of user roles for the custom entity explicitly granted by the owner.
The permissions the current viewer has with respect to a particular object.
The opaque ID of the Answer.
Example:
3
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The time the answer was created in ISO format (ISO 8601).
The time the answer was last updated in ISO format (ISO 8601).
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The parent board this answer is in.
The collections to which the answer belongs.
The document's document_category(.proto).
Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.
Example:
"ANSWERS_answer_3"
Example:
"Why is the sky blue?"
Additional ways of phrasing this question.
The plain text answer to the question.
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."
The parent board ID of this Answer, or 0 if it's a floating Answer.
Filters which restrict who should see the answer. Values are taken from the corresponding filters in people search.
A list of user roles for the answer added by the owner.
A list of user roles for the answer removed by the owner.
A list of roles for this answer explicitly granted by an owner, editor, or admin.
Available options:
DOCUMENT, ASSISTANT The permissions the current viewer has with respect to a particular object.
Heading text that was matched to produce this result.
Question text that was matched to produce this result.
Example:
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://example.com/foo/bar",
"nativeAppUrl": "slack://foo/bar",
"mustIncludeSuggestions": [
{
"missingTerm": "container",
"query": "container"
}
]
}
The attendee list, including their response status
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 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 unique ID of the Answer Board.
The unique name of the Collection.
A brief summary of the Collection's contents.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items.
A list of user roles for the Answer Board.
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.
Last file match for a repo
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
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.
A list of documents related to this structured result.
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.
The text of the related question
The answer for the related question
Subsections of the answer string to which some special formatting should be applied (eg. bold)
A subsection of a given string to which some special formatting should be applied.
A disambiguation between multiple entities with the same name
Name of the ambiguous entity
The unique id of the entity in the knowledge graph
The type of entity.
Available options:
PERSON, PROJECT, CUSTOMER Any snippets associated to the populated object.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Name of the search provider.
URL to the provider's logo.
URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
The maximum number of FacetBuckets to return in each FacetResult.
Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery.
A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields.
Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource.
Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter
Array of hints containing which fields should be populated in the response.
Hints for the response content.
Available options:
ALL_RESULT_COUNTS, FACET_RESULTS, QUERY_METADATA, RESULTS, SPELLCHECK_METADATA The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Whether or not to disable spellcheck.
Disables automatic adjustment of the input query for spelling corrections or other reasons.
[beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions.
A list of filters which restrict the search results to only the specified content.
A list of filters specifying content to avoid getting search results from. Exclusions take precendence over inclusions and other query parameters, such as search operators and search facets.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests.
Example:
{ "hasCopyPaste": true }
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 query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Name of the search provider.
URL to the provider's logo.
URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
The maximum number of FacetBuckets to return in each FacetResult.
Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery.
A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
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"
A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields.
Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource.
Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
Used by Google to indicate the index of the logged in user. Useful for generating hyperlinks that support multilogin.
Unix timestamp when this token expires (in seconds since epoch UTC).
Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter
Array of hints containing which fields should be populated in the response.
Hints for the response content.
Available options:
ALL_RESULT_COUNTS, FACET_RESULTS, QUERY_METADATA, RESULTS, SPELLCHECK_METADATA The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Whether or not to disable spellcheck.
Disables automatic adjustment of the input query for spelling corrections or other reasons.
[beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions.
A list of filters which restrict the search results to only the specified content.
Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections.
A list of filters specifying content to avoid getting search results from. Exclusions take precendence over inclusions and other query parameters, such as search operators and search facets.
Specifications for containers that should be used as part of the restriction (include/exclude). Memberships are recursively defined for a subset of datasources (currently: SharePoint, OneDrive, Google Drive, and Confluence). Please contact the Glean team to enable this for more datasources. Recursive memberships do not apply for Collections.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
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 the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. 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.
Example:
"Spreadsheet"
Available options:
EQUALS, ID_EQUALS, LT, GT Example:
"EQUALS"
DEPRECATED - please use relationType instead
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 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 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 query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
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 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.
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"
}
Unique identifier.
User-friendly display name.
Link to internal company company profile.
Link to company's associated websites.
The URL of the company's logo. Public, Glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
User facing string representing the company's location.
Example:
"New York City"
Phone number as a number string.
Fax number as a number string.
User facing string representing the company's industry.
Example:
"Finances"
Average company's annual revenue for reference.
Average company's number of employees for reference.
Company's stock symbol if company is public.
The date when the company was founded.
User facing description of company.
Example:
"Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
Link to company's associated website domains.
A map of {string, int} pairs representing counts of each document type associated with this customer.
A list of POC for company.
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"
}
A list of Customers.
Unique identifier.
Link to company's associated website domains.
A map of {string, int} pairs representing counts of each document type associated with this customer.
A list of POC for company.
A list of Customers.
The date when the interaction with customer started.
Average contract annual revenue with that customer.
User facing (potentially generated) notes about company.
Example:
"CIO is interested in trying out the product."
The date when the interaction with customer started.
Average contract annual revenue with that customer.
User facing (potentially generated) notes about company.
Example:
"CIO is interested in trying out the product."
Unique identifier
Team name
A description of the team
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.
A link to the team's photo.
A link to the team's banner photo.
Link to a team page on the internet or your company's intranet
The members on this team
Metadata about the relationship of a person to a team.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The team member's relationship to the team. This defaults to MEMBER if not set.
Available options:
MEMBER, MANAGER, LEAD, POINT_OF_CONTACT, OTHER Displayed name for the relationship if relationship is set to OTHER.
The team member's start date
Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team)
The emails for this team
An email address
Available options:
PRIMARY, SECONDARY, ONCALL, OTHER true iff the email was manually added by a user from within Glean (aka not from the original data source)
The datasource profiles of the team
The datasource the profile is of.
Example:
"github"
The display name of the entity in the given datasource.
URL to view the entity's profile.
A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...).
For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source)
the data source of the team, e.g. GDRIVE
For teams created from docs, the doc title. Otherwise empty.
when this team was last updated.
whether this team is fully processed or there are still unprocessed operations that'll affect it
Available options:
PROCESSED, QUEUED_FOR_CREATION, QUEUED_FOR_DELETION can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot
The logging id of the team used in scrubbed logs, client analytics, and metrics.
A list of objects related to a source object.
Unique identifier.
Title or name of the custom entity.
The datasource the custom entity is from.
The type of the entity. Interpretation is specific to each datasource
Custom fields specific to individual datasources
A list of user roles for the custom entity explicitly granted by the owner.
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"
}
The opaque ID of the Answer.
Example:
3
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.
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 time the answer was created in ISO format (ISO 8601).
The time the answer was last updated in ISO format (ISO 8601).
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 parent board this answer is in.
The unique ID of the Answer Board.
The unique name of the Collection.
A brief summary of the Collection's contents.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items.
A list of user roles for the Answer Board.
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 collections to which the answer belongs.
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 document's document_category(.proto).
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.
Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.
Example:
"ANSWERS_answer_3"
Example:
"Why is the sky blue?"
Additional ways of phrasing this question.
The plain text answer to the question.
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."
The parent board ID of this Answer, or 0 if it's a floating Answer.
Filters which restrict who should see the answer. 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"
A list of user roles for the answer added by the owner.
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 user roles for the answer removed by the owner.
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 roles for this answer explicitly granted by an owner, editor, or admin.
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"
}
The URL of the document.
Available options:
DOCUMENT, ASSISTANT Heading text that was matched to produce this result.
Question text that was matched to produce this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
Example:
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://example.com/foo/bar",
"nativeAppUrl": "slack://foo/bar",
"mustIncludeSuggestions": [
{
"missingTerm": "container",
"query": "container"
}
]
}
The attendee list, including their response status
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 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 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 unique ID of the Answer Board.
The unique name of the Collection.
A brief summary of the Collection's contents.
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 Answer Board. Separated from the actual items so we can grab the count without items.
A list of user roles for the Answer Board.
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"
Last file match for a repo
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
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.
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"
}
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 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 user roles removed for the Shortcut.
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"
}
The permissions the current viewer has with respect to a particular object.
Describes the write permissions levels that a user has for a specific feature
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 time the shortcut was created in ISO format (ISO 8601).
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 time the shortcut was updated in ISO format (ISO 8601).
Document that corresponds to the destination URL, if applicable.
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 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 query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
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"
}
A list of documents related to this structured result.
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)
The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
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.
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.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The text of the related question
The answer for the related question
Subsections of the answer string to which some special formatting should be applied (eg. bold)
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
A disambiguation between multiple entities with the same name
Name of the ambiguous entity
The unique id of the entity in the knowledge graph
The type of entity.
Available options:
PERSON, PROJECT, CUSTOMER Any snippets associated to the populated object.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A single object that can support any object in the work graph. Only a single object will be populated.
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 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.
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"
}
A list of people mentioned in the document.
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"
}
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 which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
The document priority. Interpretation is datasource specific.
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"
}
A list of tags for the document. Interpretation is datasource specific.
A list of collections that the document belongs to.
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 user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
The count of comments (thread replies in the case of slack).
The count of reactions on the document.
To be deprecated in favor of reacts. A (potentially non-exhaustive) list of reactions for the document.
Describes instances of someone posting a link to this document in one of our indexed datasources.
Search endpoint will only fill out numDays ago since that's all we need to display shared badge; docmetadata endpoint will fill out all the fields so that we can display shared badge tooltip
Describes the write permissions levels that a user has for a specific feature
The counter value
The unit of organization over which we did the count aggregation, e.g. org (department) or company
A list of shortcuts of which destination URL is for the document.
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.
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).
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"
}
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.
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.
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 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)
The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
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.
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.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
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
Unique identifier
Team name
Link to a team page on the internet or your company's intranet
The team member's relationship to the team. This defaults to MEMBER if not set.
Available options:
MEMBER, MANAGER, LEAD, POINT_OF_CONTACT, OTHER The team member's start date
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.
Desk number.
Location's timezone, e.g. UTC, PST.
Office address or name.
Name of the city.
State code.
Region information, e.g. NORAM, APAC.
ZIP Code for the address.
Country name.
Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA.
Link to a customer's internal profile page. This is set to '#' when no link is desired.
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 chain of reporting in the company as far up as it goes. The last entry is this person's direct manager.
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"
}
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 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"
}
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.
The datasource the profile is of.
Example:
"github"
The display name of the entity in the given datasource.
URL to view the entity's profile.
A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...).
For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source)
List of people and distances to those people from this person. Optionally with metadata.
The display name.
An opaque identifier that can be used to request metadata for a Person.
Distance to person, refer to PeopleDistance pipeline on interpretation of the value.
Information regarding the invite status of a person.
The time this person signed up in ISO format (ISO 8601).
Latest invites received by the user for each channel
Information regarding the invite status of a person for a particular channel.
The person that invited this person.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The time this person was invited in ISO format (ISO 8601).
The time this person was reminded in ISO format (ISO 8601) if a reminder was sent.
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.
TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch
TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope
TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features
Describes the read permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject
Describes the write permissions levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject
Describes the grant permission levels that a user has for permissioned features. Key must be PermissionedFeatureOrObject
The roleId of the canonical role a user has. The displayName is equal to the roleId.
The roleIds of the roles a user has.
User customizable fields for additional people information.
A user-facing label for this field.
Determines whether the client should display this custom field
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
An auto generated unique identifier.
The badge name displayed to users
Defines how to render an icon
Example:
{
"color": "#343CED",
"key": "person_icon",
"iconType": "GLYPH",
"name": "user"
}
The badge should be shown on the PersonAttribution
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"
}
Unique identifier.
User-friendly display name.
Link to internal company company profile.
Link to company's associated websites.
The URL of the company's logo. Public, Glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
User facing string representing the company's location.
Example:
"New York City"
Phone number as a number string.
Fax number as a number string.
User facing string representing the company's industry.
Example:
"Finances"
Average company's annual revenue for reference.
Average company's number of employees for reference.
Company's stock symbol if company is public.
The date when the company was founded.
User facing description of company.
Example:
"Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
Link to company's associated website domains.
A map of {string, int} pairs representing counts of each document type associated with this customer.
A list of POC for company.
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"
}
A list of Customers.
Unique identifier.
User-friendly display name.
Link to internal company company profile.
Link to company's associated websites.
The URL of the company's logo. Public, Glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
User facing string representing the company's location.
Example:
"New York City"
Phone number as a number string.
Fax number as a number string.
User facing string representing the company's industry.
Example:
"Finances"
Average company's annual revenue for reference.
Average company's number of employees for reference.
Company's stock symbol if company is public.
The date when the company was founded.
User facing description of company.
Example:
"Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
Link to company's associated website domains.
A map of {string, int} pairs representing counts of each document type associated with this customer.
A list of POC for company.
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"
}
A list of Customers.
Unique identifier.
Link to company's associated website domains.
A map of {string, int} pairs representing counts of each document type associated with this customer.
A list of POC for company.
A list of Customers.
The date when the interaction with customer started.
Average contract annual revenue with that customer.
User facing (potentially generated) notes about company.
Example:
"CIO is interested in trying out the product."
The date when the interaction with customer started.
Average contract annual revenue with that customer.
User facing (potentially generated) notes about company.
Example:
"CIO is interested in trying out the product."
The date when the interaction with customer started.
Average contract annual revenue with that customer.
User facing (potentially generated) notes about company.
Example:
"CIO is interested in trying out the product."
Unique identifier
Team name
A description of the team
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.
A link to the team's photo.
A link to the team's banner photo.
Link to a team page on the internet or your company's intranet
The members on this team
Metadata about the relationship of a person to a team.
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 team member's relationship to the team. This defaults to MEMBER if not set.
Available options:
MEMBER, MANAGER, LEAD, POINT_OF_CONTACT, OTHER Displayed name for the relationship if relationship is set to OTHER.
The team member's start date
Number of members on this team (recursive; includes all individuals that belong to this team, and all individuals that belong to a subteam within this team)
The emails for this team
An email address
Available options:
PRIMARY, SECONDARY, ONCALL, OTHER true iff the email was manually added by a user from within Glean (aka not from the original data source)
The datasource profiles of the team
The datasource the profile is of.
Example:
"github"
The display name of the entity in the given datasource.
URL to view the entity's profile.
A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...).
For internal use only. True iff the data source profile was manually added by a user from within Glean (aka not from the original data source)
the data source of the team, e.g. GDRIVE
For teams created from docs, the doc title. Otherwise empty.
when this team was last updated.
whether this team is fully processed or there are still unprocessed operations that'll affect it
Available options:
PROCESSED, QUEUED_FOR_CREATION, QUEUED_FOR_DELETION can this team be deleted. Some manually ingested teams like GCS_CSV or PUSH_API cannot
The logging id of the team used in scrubbed logs, client analytics, and metrics.
The permissions the current viewer has with respect to a particular object.
Describes the write permissions levels that a user has for a specific feature
Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
Available options:
GLOBAL, OWN True if user has create permission for this feature and scope
True if user has update permission for this feature and scope
True if user has delete permission for this feature and scope
Unique identifier.
Title or name of the custom entity.
The datasource the custom entity is from.
The type of the entity. Interpretation is specific to each datasource
A list of user roles for the custom entity explicitly granted by the owner.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
The permissions the current viewer has with respect to a particular object.
Describes the write permissions levels that a user has for a specific feature
Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
Available options:
GLOBAL, OWN True if user has create permission for this feature and scope
True if user has update permission for this feature and scope
True if user has delete permission for this feature and scope
The opaque ID of the Answer.
Example:
3
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.
Example:
"https://en.wikipedia.org/wiki/Diffuse_sky_radiation"
Example:
"Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue."
Whether the user in context liked the answer.
The total number of likes for the answer.
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 time the answer was created in ISO format (ISO 8601).
The time the answer was last updated in ISO format (ISO 8601).
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 verification state for the document.
Available options:
UNVERIFIED, VERIFIED, DEPRECATED Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The unix timestamp of the verification (in seconds since epoch UTC).
The unix timestamp of the verification expiration if applicable (in seconds since epoch UTC).
Info about all outstanding verification reminders for the document if exists.
Number of visitors to the document during included time periods.
List of potential verifiers for the document e.g. old verifiers and/or users with view/edit permissions.
The parent board this answer is in.
The unique ID of the Answer Board.
The unique name of the Collection.
A brief summary of the Collection's contents.
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 Answer Board. Separated from the actual items so we can grab the count without items.
A list of user roles for the Answer Board.
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 collections to which the answer belongs.
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 document's document_category(.proto).
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.
Glean Document ID of the Answer. The Glean Document ID is supported for cases where the Answer ID isn't available. If both are available, using the Answer ID is preferred.
Example:
"ANSWERS_answer_3"
Example:
"Why is the sky blue?"
Additional ways of phrasing this question.
The plain text answer to the question.
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."
The parent board ID of this Answer, or 0 if it's a floating Answer.
Filters which restrict who should see the answer. 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.
Example:
"Spreadsheet"
Available options:
EQUALS, ID_EQUALS, LT, GT Example:
"EQUALS"
DEPRECATED - please use relationType instead
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"
A list of user roles for the answer added by the owner.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
A list of user roles for the answer removed by the owner.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
A list of roles for this answer explicitly granted by an owner, editor, or admin.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
The URL of the document.
Available options:
DOCUMENT, ASSISTANT The permissions the current viewer has with respect to a particular object.
Describes the write permissions levels that a user has for a specific feature
Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
Available options:
GLOBAL, OWN True if user has create permission for this feature and scope
True if user has update permission for this feature and scope
True if user has delete permission for this feature and scope
Heading text that was matched to produce this result.
Question text that was matched to produce this result.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
structuredResults.extractedQnA.questionResult.allClusteredResults.visibleCountHint
integer
required
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
Example:
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": { "name": "name" },
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://example.com/foo/bar",
"nativeAppUrl": "slack://foo/bar",
"mustIncludeSuggestions": [
{
"missingTerm": "container",
"query": "container"
}
]
}
The attendee list, including their response status
Full details of some of the attendees of this event
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Whether or not this attendee is an organizer.
Whether or not this attendee is in a group. Needed temporarily at least to support both flat attendees and tree for compatibility.
If this attendee is a group, represents the list of individual attendees in the group.
Available options:
ACCEPTED, DECLINED, NO_RESPONSE, TENTATIVE 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 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 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.
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 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 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.
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.
Metadata having what categories this Collection is pinned to and the eligible categories to pin to
List of targets this Collection is pinned to.
Categories a Collection can be pinned to.
Available options:
COMPANY_RESOURCE, DEPARTMENT_RESOURCE, TEAM_RESOURCE Optional. If category supports values, then the additional value for the category e.g. department name for DEPARTMENT_RESOURCE, team name/id for TEAM_RESOURCE and so on.
What targets can a Collection be pinned to.
Available options:
RESOURCE_CARD, TEAM_PROFILE_PAGE 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.
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"
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
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.
Example:
"Spreadsheet"
Available options:
EQUALS, ID_EQUALS, LT, GT Example:
"EQUALS"
DEPRECATED - please use relationType instead
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 permissions the current viewer has with respect to a particular object.
Describes the write permissions levels that a user has for a specific feature
Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
Available options:
GLOBAL, OWN True if user has create permission for this feature and scope
True if user has update permission for this feature and scope
True if user has delete permission for this feature and scope
The unique ID of the Answer Board.
The unique name of the Collection.
A brief summary of the Collection's contents.
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 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 number of items currently in the Answer Board. Separated from the actual items so we can grab the count without items.
A list of user roles for the Answer Board.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
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.
Example:
"Spreadsheet"
Available options:
EQUALS, ID_EQUALS, LT, GT Example:
"EQUALS"
DEPRECATED - please use relationType instead
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 permissions the current viewer has with respect to a particular object.
Describes the write permissions levels that a user has for a specific feature
Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
Available options:
GLOBAL, OWN True if user has create permission for this feature and scope
True if user has update permission for this feature and scope
True if user has delete permission for this feature and scope
Index ranges depicting matched sections of the line
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
Last file match for a repo
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
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.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
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 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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
A list of user roles removed for the Shortcut.
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.
The URL of the document.
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 type of user group
Available options:
DEPARTMENT, ALL, TEAM, JOB_TITLE, ROLE_TYPE, LOCATION, REGION, EXTERNAL_GROUP A unique identifier for the group. May be the same as name.
Name of the group.
The permissions the current viewer has with respect to a particular object.
Describes the write permissions levels that a user has for a specific feature
Describes the scope for a ReadPermission, WritePermission, or GrantPermission object
Available options:
GLOBAL, OWN True if user has create permission for this feature and scope
True if user has update permission for this feature and scope
True if user has delete permission for this feature and scope
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 time the shortcut was created in ISO format (ISO 8601).
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 time the shortcut was updated in ISO format (ISO 8601).
Document that corresponds to the destination URL, if applicable.
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.
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 query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Name of the search provider.
URL to the provider's logo.
URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
The maximum number of FacetBuckets to return in each FacetResult.
Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery.
A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields.
Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource.
Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter
Array of hints containing which fields should be populated in the response.
Hints for the response content.
Available options:
ALL_RESULT_COUNTS, FACET_RESULTS, QUERY_METADATA, RESULTS, SPELLCHECK_METADATA The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Whether or not to disable spellcheck.
Disables automatic adjustment of the input query for spelling corrections or other reasons.
structuredResults.querySuggestions.suggestions.requestOptions.returnLlmContentOverSnippets
boolean
[beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions.
A list of filters which restrict the search results to only the specified content.
A list of filters specifying content to avoid getting search results from. Exclusions take precendence over inclusions and other query parameters, such as search operators and search facets.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests.
Example:
{ "hasCopyPaste": true }
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"
}
A list of documents related to this structured result.
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)
The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Name of the search provider.
URL to the provider's logo.
structuredResults.relatedDocuments.querySuggestion.searchProviderInfo.searchLinkUrlTemplate
string
URL template that can be used to perform the suggested search by replacing the {query} placeholder with the query suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
The maximum number of FacetBuckets to return in each FacetResult.
Filter results to a single datasource name (e.g. gmail, slack). All results are returned if missing.
Filter results to one or more datasources (e.g. gmail, slack). All results are returned if missing.
structuredResults.relatedDocuments.querySuggestion.requestOptions.queryOverridesFacetFilters
boolean
If true, the operators in the query are taken to override any operators in facetFilters in the case of conflict. This is used to correctly set rewrittenFacetFilters and rewrittenQuery.
A list of filters for the query. An AND is assumed between different facetFilters. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
A list of facet filter sets that will be OR'ed together. SearchRequestOptions where both facetFilterSets and facetFilters set are considered as bad request. Callers should set only one of these fields.
Within a single FacetFilterSet, the filters are treated as AND. For example, owner Sumeet and type Spreadsheet shows documents that are by Sumeet AND are Spreadsheets.
Facets for which FacetResults should be fetched and that don't apply to a particular datasource. If specified, these values will replace the standard default facets (last_updated_at, from, etc.). The requested facets will be returned alongside datasource-specific facets if searching a single datasource.
Auth tokens which may be used for non-indexed, federated results (e.g. Gmail).
structuredResults.relatedDocuments.querySuggestion.requestOptions.fetchAllDatasourceCounts
boolean
Hints that the QE should return result counts (via the datasource facet result) for all supported datasources, rather than just those specified in the datasource[s]Filter
Array of hints containing which fields should be populated in the response.
Hints for the response content.
Available options:
ALL_RESULT_COUNTS, FACET_RESULTS, QUERY_METADATA, RESULTS, SPELLCHECK_METADATA The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Whether or not to disable spellcheck.
Disables automatic adjustment of the input query for spelling corrections or other reasons.
structuredResults.relatedDocuments.querySuggestion.requestOptions.returnLlmContentOverSnippets
boolean
[beta] Enables expanded content to be returned for LLM usage. The size of content per result returned should be modified using maxSnippetSize. Server may return less or more than what is specified in maxSnippetSize. For more details, https://docs.google.com/document/d/1CTOLSxWWT9WDEnHVLoCUaxbGYyXYP8kctPRF-RluSQY/edit. Requires sufficient permissions.
A list of filters which restrict the search results to only the specified content.
A list of filters specifying content to avoid getting search results from. Exclusions take precendence over inclusions and other query parameters, such as search operators and search facets.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
Whether the associated query was at least partially copy-pasted. If subsequent requests are issued after a copy-pasted query is constructed (e.g. with facet modifications), this bit should continue to be set for those requests.
Example:
{ "hasCopyPaste": true }
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.
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 truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
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.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
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.
A list of results that should be displayed as associated with this result.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as associated with this result.
The default number of results to display before truncating and showing a "see more" link
A list of results that should be displayed as associated with this result.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...).
Text content from the result document which contains search query terms, if available.
The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack).
The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack).
A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP.
A list of results that should be displayed as associated with this result.
A list of results that should be displayed as associated with this result.
The total number of attachments.
A (potentially partial) list of results representing documents attached to the main result document.
A list of results that should be displayed as backlinks of this result in reverse chronological order.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The reason for inclusion of clusteredResults.
Available options:
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX The query being suggested (e.g. enforcing the missing term from the original query).
A query term missing from the original query on which this suggestion is based.
Information about the search provider that generated this suggestion.
Example:
{
"name": "Google",
"logo": "https://app.glean.com/images/feather/globe.svg",
"searchLinkUrlTemplate": "https://www.google.com/search?q={query}&hl=en"
}
A user-facing description to display for the suggestion.
The datasource associated with the suggestion.
Example:
{
"datasourceFilter": "JIRA",
"datasourcesFilter": ["JIRA"],
"queryOverridesFacetFilters": true,
"facetFilters": [
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
},
{
"fieldName": "fieldName",
"values": ["fieldValues", "fieldValues"]
}
]
}
The bolded ranges within the query of the QuerySuggestion.
A subsection of a given string to which some special formatting should be applied.
Example:
{ "hasCopyPaste": true }
Example:
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Additional context for the relationship between the result and the document it's attached to.
A list of pins associated with this search result.
The document which should be a pinned result.
The opaque id of the pin.
Filters which restrict who should see the pinned document. Values are taken from the corresponding filters in people search.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The query strings for which the pinned result will show.
An array of entities in the work graph retrieved via a data request.
A single object that can support any object in the work graph. Only a single object will be populated.
Example:
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Example:
{
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{ "startindex": 0, "endIndex": 5 },
{ "startIndex": 12, "endIndex": 17 }
]
}
]
}
A list of documents related to this structured result.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The text of the related question
The answer for the related question
Subsections of the answer string to which some special formatting should be applied (eg. bold)
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
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.
A disambiguation between multiple entities with the same name
Any snippets associated to the populated object.
A matching snippet from the document. Query term matches are marked by the unicode characters uE006 and uE007.
The mime type of the snippets, currently either text/plain or text/html.
A matching snippet from the document with no highlights.
Used for sorting based off the snippet's location within all_snippetable_text
The bolded ranges within text.
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
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.
A URL, generated based on availability, that links to the position of the snippet text or to the nearest header above the snippet text.
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
The level of visual distinction that should be given to a result.
Available options:
HERO, PROMOTED, STANDARD Source context for this result. Possible values depend on the result type.
Available options:
EXPERT_DETECTION, ENTITY_NLQ Search query rephrased into a question.
Answer generated for the given query or the generated question.
List of all follow-up prompts generated for the given query or the generated question.
List of follow-up actions generated for the given query or the generated question.
A follow-up action that can be invoked by the user after a response. The action parameters are not included and need to be predicted/filled separately.
Unique identifier for this actionRun recommendation event.
The ID of the action instance that will be invoked.
The ID of the associated action.
Text to be displayed to the user when recommending the action instance.
The label to be used when displaying a button to execute this action instance.
Whether user confirmation is needed before executing this action instance.
Answer subsections to mark with special formatting (citations, bolding etc)
A subsection of a given string to which some special formatting should be applied.
The inclusive start index of the range.
The exclusive end index of the range.
Available options:
BOLD, CITATION, LINK The URL associated with the range, if applicable. For example, the linked URL for a LINK range.
A document corresponding to the range, if applicable. For example, the cited document for a CITATION range.
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.
Status of backend generating the answer
Available options:
COMPUTING, DISABLED, FAILED, NO_ANSWER, SKIPPED, STREAMING, SUCCEEDED, TIMEOUT An opaque cursor representing the search request
An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
Indicates the gmail results could not be fetched due to bad token.
Indicates the outlook results could not be fetched due to bad token.
A platform-generated request ID to correlate backend logs.
Time in milliseconds the backend took to respond to the request.
Example:
1100
curl --request POST \
--url https://{domain}-be.glean.com/rest/api/v1/recommendations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"timestamp": "2023-11-07T05:31:56Z",
"trackingToken": "<string>",
"sessionInfo": {
"sessionTrackingToken": "<string>",
"tabId": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"lastQuery": "<string>"
},
"sourceDocument": {
"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>"
}
]
},
"pageSize": 100,
"maxSnippetSize": 400,
"recommendationDocumentSpec": {
"url": "<string>"
},
"requestOptions": {
"datasourceFilter": "<string>",
"datasourcesFilter": [
"<string>"
],
"facetFilterSets": [
{
"filters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
]
}
],
"context": {
"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>"
}
]
},
"resultProminence": [
"HERO"
]
}
}'{
"trackingToken": "<string>",
"sessionInfo": {
"sessionTrackingToken": "<string>",
"tabId": "<string>",
"lastSeen": "2023-11-07T05:31:56Z",
"lastQuery": "<string>"
},
"results": [
{
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {
"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {
"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://example.com/foo/bar",
"nativeAppUrl": "slack://foo/bar",
"mustIncludeSuggestions": [
{
"missingTerm": "container",
"query": "container"
}
]
}
],
"structuredResults": [
{
"document": {},
"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."
},
"team": {
"relatedObjects": {},
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": "<string>",
"name": "<string>",
"description": "<string>",
"businessUnit": "<string>",
"department": "<string>",
"photoUrl": "<string>",
"bannerUrl": "<string>",
"externalLink": "<string>",
"members": [
{
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"relationship": "MEMBER",
"customRelationshipStr": "<string>",
"joinDate": "2023-11-07T05:31:56Z"
}
],
"memberCount": 123,
"emails": [
{
"email": "jsmith@example.com",
"type": "PRIMARY",
"isUserGenerated": true
}
],
"datasourceProfiles": [
{
"datasource": "github",
"handle": "<string>",
"url": "<string>",
"nativeAppUrl": "<string>",
"isUserGenerated": true
}
],
"datasource": "<string>",
"createdFrom": "<string>",
"lastUpdatedAt": "2023-11-07T05:31:56Z",
"status": "PROCESSED",
"canBeDeleted": true,
"loggingId": "<string>"
},
"customEntity": {
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": "<string>",
"title": "<string>",
"datasource": "<string>",
"objectType": "<string>",
"metadata": {
"customData": {}
},
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"answer": {
"id": 3,
"docId": "ANSWERS_answer_3",
"question": "Why is the sky blue?",
"questionVariations": [
"<string>"
],
"bodyText": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"boardId": 123,
"audienceFilters": [
{
"fieldName": "type",
"values": [
{
"value": "Spreadsheet",
"relationType": "EQUALS"
},
{
"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"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"
}
],
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
],
"sourceDocumentSpec": {
"url": "<string>"
},
"sourceType": "DOCUMENT",
"permissions": {
"write": {
"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"combinedAnswerText": {
"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"structuredList": [
{
"link": "https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
"document": {},
"text": "Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue."
}
]
},
"likes": {
"likedBy": [
{
"user": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z"
}
],
"likedByUser": true,
"numLikes": 123
},
"author": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2023-11-07T05:31:56Z",
"updateTime": "2023-11-07T05:31:56Z",
"updatedBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"verification": {
"state": "UNVERIFIED",
"metadata": {
"lastVerifier": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"lastVerificationTs": 123,
"expirationTs": 123,
"document": {},
"reminders": [
{
"assignee": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"requestor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"remindAt": 123,
"createdAt": 123,
"reason": "<string>"
}
],
"lastReminder": {
"assignee": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"requestor": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"remindAt": 123,
"createdAt": 123,
"reason": "<string>"
},
"visitorCount": [
{
"count": 123,
"period": {
"minDaysFromNow": 123,
"maxDaysFromNow": 123,
"start": {
"epochSeconds": 123,
"daysFromNow": 123
},
"end": {
"epochSeconds": 123,
"daysFromNow": 123
}
},
"org": "<string>"
}
],
"candidateVerifiers": [
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
]
}
},
"board": {
"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"
}
]
}
],
"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,
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"collections": [
{
"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"
}
]
}
],
"documentCategory": "<string>",
"sourceDocument": {}
},
"extractedQnA": {
"heading": "<string>",
"question": "<string>",
"questionResult": "<any>"
},
"meeting": {
"id": "<string>",
"title": "<string>",
"description": "<string>",
"url": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"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
}
},
"app": {
"datasource": "<string>",
"docType": "<string>",
"mimeType": "<string>",
"iconUrl": "<string>"
},
"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"
}
]
},
"answerBoard": {
"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"
}
]
}
],
"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,
"roles": [
{
"sourceDocumentSpec": {
"url": "<string>"
},
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"group": {
"type": "DEPARTMENT",
"id": "<string>",
"name": "<string>"
},
"role": "OWNER"
}
]
},
"code": {
"repoName": "scio",
"fileName": "README.md",
"matches": [
{
"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": []
},
{
"lineNumber": 2,
"content": "Second line of the file",
"ranges": []
},
{
"lineNumber": 3,
"content": "hello world hello world",
"ranges": [
{
"startindex": 0,
"endIndex": 5
},
{
"startIndex": 12,
"endIndex": 17
}
]
}
]
},
"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"
}
]
},
"querySuggestions": {
"suggestions": [
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
],
"person": {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
},
"relatedDocuments": [
{}
],
"relatedQuestion": {
"question": "<string>",
"answer": "<string>",
"ranges": [
{
"startIndex": 123,
"endIndex": 123,
"type": "BOLD",
"url": "<string>",
"document": {}
}
]
},
"disambiguation": {
"name": "<string>",
"id": "<string>",
"type": "PERSON"
},
"snippets": [
{
"snippet": "snippet",
"mimeType": "mimeType"
}
],
"trackingToken": "<string>",
"prominence": "HERO",
"source": "EXPERT_DETECTION"
}
],
"generatedQnaResult": {
"question": "<string>",
"answer": "<string>",
"followUpPrompts": [
"<string>"
],
"followupActions": [
{
"actionRunId": "<string>",
"actionInstanceId": "<string>",
"actionId": "<string>",
"recommendationText": "<string>",
"actionLabel": "<string>",
"userConfirmationRequired": true
}
],
"ranges": [
{
"startIndex": 123,
"endIndex": 123,
"type": "BOLD",
"url": "<string>",
"document": {}
}
],
"status": "COMPUTING",
"cursor": "<string>",
"trackingToken": "<string>"
},
"errorInfo": {
"badGmailToken": true,
"badOutlookToken": true,
"invalidOperators": [
{
"key": "<string>",
"value": "<string>"
}
],
"errorMessages": [
{
"source": "<string>",
"errorMessage": "<string>"
}
]
},
"requestID": "<string>",
"backendTimeMillis": 1100
}