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
Create shortcut
Create a user-generated shortcut that contains an alias and destination URL.
curl --request POST \
--url https://{domain}-be.glean.com/rest/api/v1/createshortcut \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"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"
}
]
}
}'{
"shortcut": {
"id": 123,
"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": [
{}
]
},
"error": {
"errorType": "NO_PERMISSION"
}
}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
Link text following go/ prefix as entered by the user.
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.
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.
How this document relates to the including entity.
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)
{
"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.
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE "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.
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The type of user group
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.
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.
How this document relates to the including entity.
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)
{
"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.
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE "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.
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The type of user group
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.
Response
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.
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.
How this document relates to the including entity.
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)
{
"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.
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE "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.
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The type of user group
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.
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.
How this document relates to the including entity.
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)
{
"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.
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE "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.
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The type of user group
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.
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.
How this document relates to the including entity.
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)
{
"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.
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE "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.
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The type of user group
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
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.
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": "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.
{
"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.
{ "hasCopyPaste": true }
{
"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
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.
{
"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.
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX {
"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.
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.
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE "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.
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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"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.
{
"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.
{
"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.
"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.
{
"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
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"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.
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": "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.
{
"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.
{ "hasCopyPaste": true }
{
"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
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.
{
"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.
SIMILAR, FRESHNESS, TITLE, CONTENT, NONE, THREAD_REPLY, THREAD_ROOT, PREFIX, SUFFIX {
"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.
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.
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE "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.
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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"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.
{
"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.
{
"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.
"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.
{
"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
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"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
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
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.
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
{
"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.
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.
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
{
"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).
{
"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.
{
"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
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.
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
{
"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.
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.
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
{
"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).
{
"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.
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"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.
{
"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.
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.
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"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.
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
{
"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.
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The time the shortcut was created in ISO format (ISO 8601).
{
"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.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"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
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.
{
"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.
{
"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.
curl --request POST \
--url https://{domain}-be.glean.com/rest/api/v1/createshortcut \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"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"
}
]
}
}'{
"shortcut": {
"id": 123,
"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": [
{}
]
},
"error": {
"errorType": "NO_PERMISSION"
}
}