--- title: "Get insights" method: POST path: "/rest/api/v1/insights" tags: ["Insights"] --- # Get insights `POST /rest/api/v1/insights` Gets the aggregate usage insights data displayed in the Insights Dashboards. ## Query parameters - `locale` string ## Request body - InsightsRequest - `overviewRequest` InsightsOverviewRequest - `departments` string[] — Departments for which Insights are requested. - `managerEmails` string[] — Manager emails whose teams should be filtered for. Empty array means no filtering. - `dayRange` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `assistantRequest` InsightsAssistantRequest - `departments` string[] — Departments for which Insights are requested. - `managerEmails` string[] — Manager emails whose teams should be filtered for. Empty array means no filtering. - `dayRange` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `agentsRequest` AgentsInsightsV2Request - `agentIds` string[] — IDs of the Agents for which Insights should be returned. An empty array signifies all. - `departments` string[] — Departments for which Insights are requested. - `managerEmails` string[] — Manager emails whose teams should be filtered for. Empty array means no filtering. - `dayRange` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `mcpRequest` McpInsightsRequest - `departments` string[] — Departments for which Insights are requested. - `managerIds` string[] — Manager user IDs whose teams should be filtered for. Empty array means no filtering. - `managerEmails` string[] — Manager emails whose teams should be filtered for. Empty array means no filtering. - `dayRange` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `mcpBreakdownRequest` McpBreakdownInsightsRequest - `departments` string[] — Departments for which Insights are requested. - `managerIds` string[] — Manager user IDs whose teams should be filtered for. Empty array means no filtering. - `managerEmails` string[] — Manager emails whose teams should be filtered for. Empty array means no filtering. - `dayRange` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `breakdownType` 'USERS' | 'HOST_APPLICATIONS' | 'TOOLS' | 'SERVERS' — Type of breakdown to return. - `hostApplications` string[] — Host applications to filter by. Empty array means all host applications. - `tools` string[] — MCP tools to filter by. Empty array means all tools. - `servers` string[] — MCP servers to filter by. Empty array means all servers. - `disablePerUserInsights` boolean — If true, suppresses the generation of per-user Insights in the response. Default is false. ## Response `200` OK - InsightsResponse - `gleanAssist` GleanAssistInsightsResponse - `lastLogTimestamp` integer — Unix timestamp of the last activity processed to make the response (in seconds since epoch UTC). - `activityInsights` UserActivityInsight[] — Insights for all active users with respect to set of actions. - `user` Person, required - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `relatedDocuments` RelatedDocuments[] — A list of documents related to this person. - `relation` 'ATTACHMENT' | 'CANONICAL' | 'CASE' | 'contact' | 'CONTACT' | 'CONVERSATION_MESSAGES' | 'EXPERT' | 'FROM' | 'HIGHLIGHT' | 'opportunity' | 'OPPORTUNITY' | 'RECENT' | 'SOURCE' | 'TICKET' | 'TRANSCRIPT' | 'WITH' — How this document relates to the including entity. - `associatedEntityId` string — Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - `querySuggestion` QuerySuggestion - `missingTerm` string — A query term missing from the original query on which this suggestion is based. - `query` string, required — The query being suggested (e.g. enforcing the missing term from the original query). - `searchProviderInfo` SearchProviderInfo - … - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - … - `requestOptions` SearchRequestOptions - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - … - `inputDetails` SearchRequestInputDetails - … - `documents` Document[] — A truncated list of documents with this relation. TO BE DEPRECATED. - `id` string — The Glean Document ID. - `datasource` string — The app or other repository type from which the document was extracted - `connectorType` 'API_CRAWL' | 'BROWSER_CRAWL' | 'BROWSER_HISTORY' | 'BUILTIN' | 'FEDERATED_SEARCH' | 'PUSH_API' | 'WEB_CRAWL' | 'NATIVE_HISTORY' — The source from which document content was pulled, e.g. an API crawl or browser history - `docType` string — The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `content` DocumentContent - … - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - … - `sections` DocumentSection[] — A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - … - `results` SearchResult[] — A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - `structuredResults` StructuredResult[] — An array of entities in the work graph retrieved via a data request. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `document` Document - … - `title` string - `url` string, required - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - `snippets` SearchResultSnippet[] — Text content from the result document which contains search query terms, if available. - … - `fullText` string — 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). - `fullTextList` string[] — 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). - `relatedResults` RelatedDocuments[] — 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. - `clusteredResults` SearchResult[] — A list of results that should be displayed as associated with this result. - `allClusteredResults` ClusterGroup[] — A list of results that should be displayed as associated with this result. - … - `attachmentCount` integer — The total number of attachments. - `attachments` SearchResult[] — A (potentially partial) list of results representing documents attached to the main result document. - `backlinkResults` SearchResult[] — A list of results that should be displayed as backlinks of this result in reverse chronological order. - `clusterType` 'SIMILAR' | 'FRESHNESS' | 'TITLE' | 'CONTENT' | 'NONE' | 'THREAD_REPLY' | 'THREAD_ROOT' | 'PREFIX' | 'SUFFIX' | 'AUTHOR_PREFIX' | 'AUTHOR_SUFFIX' — The reason for inclusion of clusteredResults. - `mustIncludeSuggestions` QuerySuggestionList - … - `querySuggestion` QuerySuggestion - … - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `attachmentContext` string — Additional context for the relationship between the result and the document it's attached to. - `pins` PinDocument[] — A list of pins associated with this search result. - … - `metadata` PersonMetadata - `type` 'FULL_TIME' | 'CONTRACTOR' | 'NON_EMPLOYEE' | 'FORMER_EMPLOYEE' - `firstName` string — The first name of the person - `lastName` string — The last name of the person - `title` string — Job title. - `businessUnit` string — Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - `department` string — An organizational unit where everyone has a similar task, e.g. `Engineering`. - `jobFunction` string — Normalized job-function category assigned by Entity Builder from the source department and, when available, job title. Unlike `department`, which preserves the company-specific organizational unit, this field groups departments into configured categories such as `Engineering`, `Sales`, or `IT`; it may be `Unknown` when the mapping is inconclusive. - `teams` PersonTeam[] — Info about the employee's team(s). - `id` string — Unique identifier - `name` string — Team name - `externalLink` string, uri — Link to a team page on the internet or your company's intranet - `relationship` 'MEMBER' | 'MANAGER' | 'LEAD' | 'POINT_OF_CONTACT' | 'OTHER' — The team member's relationship to the team. This defaults to MEMBER if not set. - `joinDate` string, date-time — The team member's start date - `departmentCount` integer — The number of people in this person's department. - `email` string — The user's primary email address - `aliasEmails` string[] — Additional email addresses of this user beyond the primary, if any. - `location` string — User facing string representing the person's location. - `structuredLocation` StructuredLocation — Detailed location with information about country, state, city etc. - `deskLocation` string — Desk number. - `timezone` string — Location's timezone, e.g. UTC, PST. - `address` string — Office address or name. - `city` string — Name of the city. - `state` string — State code. - `region` string — Region information, e.g. NORAM, APAC. - `zipCode` string — ZIP Code for the address. - `country` string — Country name. - `countryCode` string — Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - `externalProfileLink` string — Link to a customer's internal profile page. This is set to '#' when no link is desired. - `manager` Person — recursive - `managementChain` Person[] — The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - `phone` string — Phone number as a number string. - `timezone` string — The timezone of the person. E.g. "Pacific Daylight Time". - `timezoneOffset` integer — The offset of the person's timezone in seconds from UTC. - `timezoneIANA` string — The IANA timezone identifier, e.g. "America/Los_Angeles". - `photoUrl` string, url — The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - `uneditedPhotoUrl` string, url — The original photo URL of the person's avatar before any edits they made are applied - `bannerUrl` string, url — The URL of the person's banner photo. - `reports` Person[] - `startDate` string, date — The date when the employee started. - `endDate` string, date — If a former employee, the last date of employment. - `bio` string — Short biography or mission statement of the employee. - `pronoun` string — She/her, He/his or other pronoun. - `orgSizeCount` integer — The total recursive size of the people reporting to this person, or 1 - `directReportsCount` integer — The total number of people who directly report to this person, or 0 - `preferredName` string — The preferred name of the person, or a nickname. - `socialNetwork` SocialNetwork[] — List of social network profiles. - `name` string, required — Possible values are "twitter", "linkedin". - `profileName` string — Human-readable profile name. - `profileUrl` string, url, required — Link to profile. - `datasourceProfile` DatasourceProfile[] — List of profiles this user has in different datasources / tools that they use. - `datasource` string, required — The datasource the profile is of. - `handle` string, required — The display name of the entity in the given datasource. - `url` string — URL to view the entity's profile. - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - `isUserGenerated` boolean — 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) - `querySuggestions` QuerySuggestionList - `suggestions` QuerySuggestion[] - … - `person` Person — recursive - `peopleDistance` PersonDistance[] — List of people and distances to those people from this person. Optionally with metadata. - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `distance` number, float, required — Distance to person, refer to PeopleDistance pipeline on interpretation of the value. - `inviteInfo` InviteInfo — Information regarding the invite status of a person. - `signUpTime` string, date-time — The time this person signed up in ISO format (ISO 8601). - `invites` ChannelInviteInfo[] — Latest invites received by the user for each channel - … - `inviter` Person — recursive - `inviteTime` string, date-time — The time this person was invited in ISO format (ISO 8601). - `reminderTime` string, date-time — The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - `isSignedUp` boolean — Whether the user has signed into Glean at least once. - `lastExtensionUse` string, date-time — The last time the user has used the Glean extension in ISO 8601 format. - `permissions` Permissions — 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. - `canAdminSearch` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch - `canAdminClientApiGlobalTokens` boolean — TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope - `canDlp` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features - `read` unknown - `write` unknown - `grant` unknown - `role` string — The roleId of the canonical role a user has. The displayName is equal to the roleId. - `roles` string[] — The roleIds of the roles a user has. - `customFields` CustomFieldData[] — User customizable fields for additional people information. - `label` string, required — A user-facing label for this field. - `values` CustomFieldValue[], required - … - `displayable` boolean, required — Determines whether the client should display this custom field - `loggingId` string — The logging id of the person used in scrubbed logs, tracking GA metrics. - `startDatePercentile` number, float — Percentage of the company that started strictly after this person. Between [0,100). - `busyEvents` AnonymousEvent[] — Intervals of busy time for this person, along with the type of event they're busy with. - `time` TimeInterval - … - `eventType` 'DEFAULT' | 'OUT_OF_OFFICE' — The nature of the event, for example "out of office". - `profileBoolSettings` object — flag settings to indicate user profile settings for certain items - `badges` Badge[] — The badges that a user has earned over their lifetime. - `key` string — An auto generated unique identifier. - `displayName` string — The badge name displayed to users - `iconConfig` IconConfig — Defines how to render an icon - … - `pinned` boolean — The badge should be shown on the PersonAttribution - `isOrgRoot` boolean — Whether this person is a "root" node in their organization's hierarchy. - `activity` 'ALL' | 'SEARCH', required — Activity e.g. search, home page visit or all. - `lastActivityTimestamp` integer — Unix timestamp of the last activity (in seconds since epoch UTC). - `activityCount` CountInfo - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `activeDayCount` CountInfo - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `totalActiveUsers` integer — Total number of active users in the requested period. - `datasourceInstances` string[] — List of datasource instances for which glean assist is enabled. - `departments` string[] — List of departments applicable for users tab. - `overviewResponse` InsightsOverviewResponse - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `departments` string[] — Department name(s). - `employeeCount` integer — Number of current employees in the specified departments, according to the Org Chart. - `totalSignups` integer — Number of current signed up employees in the specified departments, according to the Org Chart. - `searchSummary` InsightsSearchSummary - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `numSearches` integer — Total number of searches by users over the specified time period. - `numSearchUsers` integer — Total number of distinct users who searched over the specified time period. - `chatSummary` InsightsChatSummary - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `numChats` integer — Total number of chats by users over the specified time period. - `numChatUsers` integer — Total number of distinct users who used Chat over the specified time period. - `searchActiveUsers` CurrentActiveUsers - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `assistantActiveUsers` CurrentActiveUsers - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `agentsActiveUsers` CurrentActiveUsers - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `mcpActiveUsers` CurrentActiveUsers - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `extensionSummary` CurrentActiveUsers - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `ugcSummary` CurrentActiveUsers - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `lastUpdatedTs` integer — Unix timestamp of the last update for the insights data in the response. - `searchSessionSatisfaction` number, float — Search session satisfaction rate, over the specified time period in the specified departments. - `monthlyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `weeklyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `dailyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `searchMonthlyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `searchWeeklyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `searchDailyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `assistantMonthlyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `assistantWeeklyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `assistantDailyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `agentsMonthlyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `agentsWeeklyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `agentsDailyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `mcpMonthlyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `mcpWeeklyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `mcpDailyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `searchesTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `assistantInteractionsTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `agentRunsTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `mcpCallsTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `searchDatasourceCounts` object — Counts of search result clicks, by datasource, over the specified time period in the specified departments. - `chatDatasourceCounts` object — Counts of cited documents in chat, by datasource, over the specified time period in the specified departments. - `perUserInsights` PerUserInsight[] — Per-user insights, over the specified time period in the specified departments. All current users in the organization who have signed into Glean at least once are included. - `person` Person - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `relatedDocuments` RelatedDocuments[] — A list of documents related to this person. - `relation` 'ATTACHMENT' | 'CANONICAL' | 'CASE' | 'contact' | 'CONTACT' | 'CONVERSATION_MESSAGES' | 'EXPERT' | 'FROM' | 'HIGHLIGHT' | 'opportunity' | 'OPPORTUNITY' | 'RECENT' | 'SOURCE' | 'TICKET' | 'TRANSCRIPT' | 'WITH' — How this document relates to the including entity. - `associatedEntityId` string — Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - `querySuggestion` QuerySuggestion - `missingTerm` string — A query term missing from the original query on which this suggestion is based. - `query` string, required — The query being suggested (e.g. enforcing the missing term from the original query). - `searchProviderInfo` SearchProviderInfo - … - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - … - `requestOptions` SearchRequestOptions - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - … - `inputDetails` SearchRequestInputDetails - … - `documents` Document[] — A truncated list of documents with this relation. TO BE DEPRECATED. - `id` string — The Glean Document ID. - `datasource` string — The app or other repository type from which the document was extracted - `connectorType` 'API_CRAWL' | 'BROWSER_CRAWL' | 'BROWSER_HISTORY' | 'BUILTIN' | 'FEDERATED_SEARCH' | 'PUSH_API' | 'WEB_CRAWL' | 'NATIVE_HISTORY' — The source from which document content was pulled, e.g. an API crawl or browser history - `docType` string — The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `content` DocumentContent - … - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - … - `sections` DocumentSection[] — A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - … - `results` SearchResult[] — A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - `structuredResults` StructuredResult[] — An array of entities in the work graph retrieved via a data request. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `document` Document - … - `title` string - `url` string, required - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - `snippets` SearchResultSnippet[] — Text content from the result document which contains search query terms, if available. - … - `fullText` string — 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). - `fullTextList` string[] — 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). - `relatedResults` RelatedDocuments[] — 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. - `clusteredResults` SearchResult[] — A list of results that should be displayed as associated with this result. - `allClusteredResults` ClusterGroup[] — A list of results that should be displayed as associated with this result. - … - `attachmentCount` integer — The total number of attachments. - `attachments` SearchResult[] — A (potentially partial) list of results representing documents attached to the main result document. - `backlinkResults` SearchResult[] — A list of results that should be displayed as backlinks of this result in reverse chronological order. - `clusterType` 'SIMILAR' | 'FRESHNESS' | 'TITLE' | 'CONTENT' | 'NONE' | 'THREAD_REPLY' | 'THREAD_ROOT' | 'PREFIX' | 'SUFFIX' | 'AUTHOR_PREFIX' | 'AUTHOR_SUFFIX' — The reason for inclusion of clusteredResults. - `mustIncludeSuggestions` QuerySuggestionList - … - `querySuggestion` QuerySuggestion - … - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `attachmentContext` string — Additional context for the relationship between the result and the document it's attached to. - `pins` PinDocument[] — A list of pins associated with this search result. - … - `metadata` PersonMetadata - `type` 'FULL_TIME' | 'CONTRACTOR' | 'NON_EMPLOYEE' | 'FORMER_EMPLOYEE' - `firstName` string — The first name of the person - `lastName` string — The last name of the person - `title` string — Job title. - `businessUnit` string — Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - `department` string — An organizational unit where everyone has a similar task, e.g. `Engineering`. - `jobFunction` string — Normalized job-function category assigned by Entity Builder from the source department and, when available, job title. Unlike `department`, which preserves the company-specific organizational unit, this field groups departments into configured categories such as `Engineering`, `Sales`, or `IT`; it may be `Unknown` when the mapping is inconclusive. - `teams` PersonTeam[] — Info about the employee's team(s). - `id` string — Unique identifier - `name` string — Team name - `externalLink` string, uri — Link to a team page on the internet or your company's intranet - `relationship` 'MEMBER' | 'MANAGER' | 'LEAD' | 'POINT_OF_CONTACT' | 'OTHER' — The team member's relationship to the team. This defaults to MEMBER if not set. - `joinDate` string, date-time — The team member's start date - `departmentCount` integer — The number of people in this person's department. - `email` string — The user's primary email address - `aliasEmails` string[] — Additional email addresses of this user beyond the primary, if any. - `location` string — User facing string representing the person's location. - `structuredLocation` StructuredLocation — Detailed location with information about country, state, city etc. - `deskLocation` string — Desk number. - `timezone` string — Location's timezone, e.g. UTC, PST. - `address` string — Office address or name. - `city` string — Name of the city. - `state` string — State code. - `region` string — Region information, e.g. NORAM, APAC. - `zipCode` string — ZIP Code for the address. - `country` string — Country name. - `countryCode` string — Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - `externalProfileLink` string — Link to a customer's internal profile page. This is set to '#' when no link is desired. - `manager` Person — recursive - `managementChain` Person[] — The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - `phone` string — Phone number as a number string. - `timezone` string — The timezone of the person. E.g. "Pacific Daylight Time". - `timezoneOffset` integer — The offset of the person's timezone in seconds from UTC. - `timezoneIANA` string — The IANA timezone identifier, e.g. "America/Los_Angeles". - `photoUrl` string, url — The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - `uneditedPhotoUrl` string, url — The original photo URL of the person's avatar before any edits they made are applied - `bannerUrl` string, url — The URL of the person's banner photo. - `reports` Person[] - `startDate` string, date — The date when the employee started. - `endDate` string, date — If a former employee, the last date of employment. - `bio` string — Short biography or mission statement of the employee. - `pronoun` string — She/her, He/his or other pronoun. - `orgSizeCount` integer — The total recursive size of the people reporting to this person, or 1 - `directReportsCount` integer — The total number of people who directly report to this person, or 0 - `preferredName` string — The preferred name of the person, or a nickname. - `socialNetwork` SocialNetwork[] — List of social network profiles. - `name` string, required — Possible values are "twitter", "linkedin". - `profileName` string — Human-readable profile name. - `profileUrl` string, url, required — Link to profile. - `datasourceProfile` DatasourceProfile[] — List of profiles this user has in different datasources / tools that they use. - `datasource` string, required — The datasource the profile is of. - `handle` string, required — The display name of the entity in the given datasource. - `url` string — URL to view the entity's profile. - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - `isUserGenerated` boolean — 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) - `querySuggestions` QuerySuggestionList - `suggestions` QuerySuggestion[] - … - `person` Person — recursive - `peopleDistance` PersonDistance[] — List of people and distances to those people from this person. Optionally with metadata. - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `distance` number, float, required — Distance to person, refer to PeopleDistance pipeline on interpretation of the value. - `inviteInfo` InviteInfo — Information regarding the invite status of a person. - `signUpTime` string, date-time — The time this person signed up in ISO format (ISO 8601). - `invites` ChannelInviteInfo[] — Latest invites received by the user for each channel - … - `inviter` Person — recursive - `inviteTime` string, date-time — The time this person was invited in ISO format (ISO 8601). - `reminderTime` string, date-time — The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - `isSignedUp` boolean — Whether the user has signed into Glean at least once. - `lastExtensionUse` string, date-time — The last time the user has used the Glean extension in ISO 8601 format. - `permissions` Permissions — 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. - `canAdminSearch` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch - `canAdminClientApiGlobalTokens` boolean — TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope - `canDlp` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features - `read` unknown - `write` unknown - `grant` unknown - `role` string — The roleId of the canonical role a user has. The displayName is equal to the roleId. - `roles` string[] — The roleIds of the roles a user has. - `customFields` CustomFieldData[] — User customizable fields for additional people information. - `label` string, required — A user-facing label for this field. - `values` CustomFieldValue[], required - … - `displayable` boolean, required — Determines whether the client should display this custom field - `loggingId` string — The logging id of the person used in scrubbed logs, tracking GA metrics. - `startDatePercentile` number, float — Percentage of the company that started strictly after this person. Between [0,100). - `busyEvents` AnonymousEvent[] — Intervals of busy time for this person, along with the type of event they're busy with. - `time` TimeInterval - … - `eventType` 'DEFAULT' | 'OUT_OF_OFFICE' — The nature of the event, for example "out of office". - `profileBoolSettings` object — flag settings to indicate user profile settings for certain items - `badges` Badge[] — The badges that a user has earned over their lifetime. - `key` string — An auto generated unique identifier. - `displayName` string — The badge name displayed to users - `iconConfig` IconConfig — Defines how to render an icon - … - `pinned` boolean — The badge should be shown on the PersonAttribution - `isOrgRoot` boolean — Whether this person is a "root" node in their organization's hierarchy. - `numSearches` integer — Total number of searches by this user over the specified time period. - `numChats` integer — Total number of chats by this user over the specified time period. - `numActiveSessions` integer — Total number of active sessions by this user in a Glean client over the specified time period. - `numGleanbotUsefulResponses` integer — Total number of Gleanbot responses marked useful by this user over the specified time period. - `numDaysActive` integer — Total number of days this user was an Active User over the specified time period. - `numSummarizations` integer — Total number of summarized items by this user over the specified time period. - `numAiAnswers` integer — Total number of AI Answers interacted with by this user over the specified time period. - `numAgentRuns` integer — Total number of agent runs for this user over the specified time period. - `numMcpCalls` integer — Total number of MCP calls for this user over the specified time period. - `assistantResponse` AssistantInsightsResponse - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `lastUpdatedTs` integer — Unix timestamp of the last update for the insights data in the response. - `monthlyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `weeklyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `dailyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `totalSignups` integer — Number of current signed up employees in the specified departments, according to the Org Chart. - `chatMessagesTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `summarizationsTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `aiAnswersTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `gleanbotInteractionsTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `perUserInsights` PerUserAssistantInsight[] - `person` Person - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `relatedDocuments` RelatedDocuments[] — A list of documents related to this person. - `relation` 'ATTACHMENT' | 'CANONICAL' | 'CASE' | 'contact' | 'CONTACT' | 'CONVERSATION_MESSAGES' | 'EXPERT' | 'FROM' | 'HIGHLIGHT' | 'opportunity' | 'OPPORTUNITY' | 'RECENT' | 'SOURCE' | 'TICKET' | 'TRANSCRIPT' | 'WITH' — How this document relates to the including entity. - `associatedEntityId` string — Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - `querySuggestion` QuerySuggestion - `missingTerm` string — A query term missing from the original query on which this suggestion is based. - `query` string, required — The query being suggested (e.g. enforcing the missing term from the original query). - `searchProviderInfo` SearchProviderInfo - … - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - … - `requestOptions` SearchRequestOptions - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - … - `inputDetails` SearchRequestInputDetails - … - `documents` Document[] — A truncated list of documents with this relation. TO BE DEPRECATED. - `id` string — The Glean Document ID. - `datasource` string — The app or other repository type from which the document was extracted - `connectorType` 'API_CRAWL' | 'BROWSER_CRAWL' | 'BROWSER_HISTORY' | 'BUILTIN' | 'FEDERATED_SEARCH' | 'PUSH_API' | 'WEB_CRAWL' | 'NATIVE_HISTORY' — The source from which document content was pulled, e.g. an API crawl or browser history - `docType` string — The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `content` DocumentContent - … - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - … - `sections` DocumentSection[] — A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - … - `results` SearchResult[] — A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - `structuredResults` StructuredResult[] — An array of entities in the work graph retrieved via a data request. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `document` Document - … - `title` string - `url` string, required - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - `snippets` SearchResultSnippet[] — Text content from the result document which contains search query terms, if available. - … - `fullText` string — 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). - `fullTextList` string[] — 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). - `relatedResults` RelatedDocuments[] — 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. - `clusteredResults` SearchResult[] — A list of results that should be displayed as associated with this result. - `allClusteredResults` ClusterGroup[] — A list of results that should be displayed as associated with this result. - … - `attachmentCount` integer — The total number of attachments. - `attachments` SearchResult[] — A (potentially partial) list of results representing documents attached to the main result document. - `backlinkResults` SearchResult[] — A list of results that should be displayed as backlinks of this result in reverse chronological order. - `clusterType` 'SIMILAR' | 'FRESHNESS' | 'TITLE' | 'CONTENT' | 'NONE' | 'THREAD_REPLY' | 'THREAD_ROOT' | 'PREFIX' | 'SUFFIX' | 'AUTHOR_PREFIX' | 'AUTHOR_SUFFIX' — The reason for inclusion of clusteredResults. - `mustIncludeSuggestions` QuerySuggestionList - … - `querySuggestion` QuerySuggestion - … - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `attachmentContext` string — Additional context for the relationship between the result and the document it's attached to. - `pins` PinDocument[] — A list of pins associated with this search result. - … - `metadata` PersonMetadata - `type` 'FULL_TIME' | 'CONTRACTOR' | 'NON_EMPLOYEE' | 'FORMER_EMPLOYEE' - `firstName` string — The first name of the person - `lastName` string — The last name of the person - `title` string — Job title. - `businessUnit` string — Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - `department` string — An organizational unit where everyone has a similar task, e.g. `Engineering`. - `jobFunction` string — Normalized job-function category assigned by Entity Builder from the source department and, when available, job title. Unlike `department`, which preserves the company-specific organizational unit, this field groups departments into configured categories such as `Engineering`, `Sales`, or `IT`; it may be `Unknown` when the mapping is inconclusive. - `teams` PersonTeam[] — Info about the employee's team(s). - `id` string — Unique identifier - `name` string — Team name - `externalLink` string, uri — Link to a team page on the internet or your company's intranet - `relationship` 'MEMBER' | 'MANAGER' | 'LEAD' | 'POINT_OF_CONTACT' | 'OTHER' — The team member's relationship to the team. This defaults to MEMBER if not set. - `joinDate` string, date-time — The team member's start date - `departmentCount` integer — The number of people in this person's department. - `email` string — The user's primary email address - `aliasEmails` string[] — Additional email addresses of this user beyond the primary, if any. - `location` string — User facing string representing the person's location. - `structuredLocation` StructuredLocation — Detailed location with information about country, state, city etc. - `deskLocation` string — Desk number. - `timezone` string — Location's timezone, e.g. UTC, PST. - `address` string — Office address or name. - `city` string — Name of the city. - `state` string — State code. - `region` string — Region information, e.g. NORAM, APAC. - `zipCode` string — ZIP Code for the address. - `country` string — Country name. - `countryCode` string — Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - `externalProfileLink` string — Link to a customer's internal profile page. This is set to '#' when no link is desired. - `manager` Person — recursive - `managementChain` Person[] — The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - `phone` string — Phone number as a number string. - `timezone` string — The timezone of the person. E.g. "Pacific Daylight Time". - `timezoneOffset` integer — The offset of the person's timezone in seconds from UTC. - `timezoneIANA` string — The IANA timezone identifier, e.g. "America/Los_Angeles". - `photoUrl` string, url — The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - `uneditedPhotoUrl` string, url — The original photo URL of the person's avatar before any edits they made are applied - `bannerUrl` string, url — The URL of the person's banner photo. - `reports` Person[] - `startDate` string, date — The date when the employee started. - `endDate` string, date — If a former employee, the last date of employment. - `bio` string — Short biography or mission statement of the employee. - `pronoun` string — She/her, He/his or other pronoun. - `orgSizeCount` integer — The total recursive size of the people reporting to this person, or 1 - `directReportsCount` integer — The total number of people who directly report to this person, or 0 - `preferredName` string — The preferred name of the person, or a nickname. - `socialNetwork` SocialNetwork[] — List of social network profiles. - `name` string, required — Possible values are "twitter", "linkedin". - `profileName` string — Human-readable profile name. - `profileUrl` string, url, required — Link to profile. - `datasourceProfile` DatasourceProfile[] — List of profiles this user has in different datasources / tools that they use. - `datasource` string, required — The datasource the profile is of. - `handle` string, required — The display name of the entity in the given datasource. - `url` string — URL to view the entity's profile. - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - `isUserGenerated` boolean — 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) - `querySuggestions` QuerySuggestionList - `suggestions` QuerySuggestion[] - … - `person` Person — recursive - `peopleDistance` PersonDistance[] — List of people and distances to those people from this person. Optionally with metadata. - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `distance` number, float, required — Distance to person, refer to PeopleDistance pipeline on interpretation of the value. - `inviteInfo` InviteInfo — Information regarding the invite status of a person. - `signUpTime` string, date-time — The time this person signed up in ISO format (ISO 8601). - `invites` ChannelInviteInfo[] — Latest invites received by the user for each channel - … - `inviter` Person — recursive - `inviteTime` string, date-time — The time this person was invited in ISO format (ISO 8601). - `reminderTime` string, date-time — The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - `isSignedUp` boolean — Whether the user has signed into Glean at least once. - `lastExtensionUse` string, date-time — The last time the user has used the Glean extension in ISO 8601 format. - `permissions` Permissions — 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. - `canAdminSearch` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch - `canAdminClientApiGlobalTokens` boolean — TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope - `canDlp` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features - `read` unknown - `write` unknown - `grant` unknown - `role` string — The roleId of the canonical role a user has. The displayName is equal to the roleId. - `roles` string[] — The roleIds of the roles a user has. - `customFields` CustomFieldData[] — User customizable fields for additional people information. - `label` string, required — A user-facing label for this field. - `values` CustomFieldValue[], required - … - `displayable` boolean, required — Determines whether the client should display this custom field - `loggingId` string — The logging id of the person used in scrubbed logs, tracking GA metrics. - `startDatePercentile` number, float — Percentage of the company that started strictly after this person. Between [0,100). - `busyEvents` AnonymousEvent[] — Intervals of busy time for this person, along with the type of event they're busy with. - `time` TimeInterval - … - `eventType` 'DEFAULT' | 'OUT_OF_OFFICE' — The nature of the event, for example "out of office". - `profileBoolSettings` object — flag settings to indicate user profile settings for certain items - `badges` Badge[] — The badges that a user has earned over their lifetime. - `key` string — An auto generated unique identifier. - `displayName` string — The badge name displayed to users - `iconConfig` IconConfig — Defines how to render an icon - … - `pinned` boolean — The badge should be shown on the PersonAttribution - `isOrgRoot` boolean — Whether this person is a "root" node in their organization's hierarchy. - `numChatMessages` integer — Total number of chat messages sent by this user over the specified time period. - `numSummarizations` integer — Total number of summarized items by this user over the specified time period. - `numAiAnswers` integer — Total number of AI Answers interacted with by this user over the specified time period. - `numGleanbotInteractions` integer — Total number of Gleanbot responses marked useful by this user over the specified time period. - `numDaysActive` integer — Total number of days this user was active on the Assistant over the specified time period. - `upvotesTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `downvotesTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `agentsResponse` AgentsInsightsV2Response - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `monthlyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `weeklyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `dailyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `sharedAgentsCount` integer — Total number of shared agents. - `topAgentsInsights` PerAgentInsight[] - `agentId` string — Agent ID - `agentName` string — Agent name - `icon` IconConfig — Defines how to render an icon - `generatedBackgroundColorKey` string - `backgroundColor` string - `color` string - `key` string - `iconType` 'COLLECTION' | 'CUSTOM' | 'DATASOURCE' | 'DATASOURCE_INSTANCE' | 'FAVICON' | 'FILE_TYPE' | 'GENERATED_BACKGROUND' | 'GLYPH' | 'MIME_TYPE' | 'NO_ICON' | 'PERSON' | 'REACTIONS' | 'URL' - `masked` boolean — Whether the icon should be masked based on current theme. - `name` string — The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - `url` string — The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - `isDeleted` boolean — Indicates whether the agent has been deleted - `userCount` integer — Total number of users for this agent over the specified time period. - `runCount` integer — Total number of runs for this agent over the specified time period. - `upvoteCount` integer — Total number of upvotes for this agent over the specified time period. - `downvoteCount` integer — Total number of downvotes for this agent over the specified time period. - `owner` Person - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `relatedDocuments` RelatedDocuments[] — A list of documents related to this person. - `relation` 'ATTACHMENT' | 'CANONICAL' | 'CASE' | 'contact' | 'CONTACT' | 'CONVERSATION_MESSAGES' | 'EXPERT' | 'FROM' | 'HIGHLIGHT' | 'opportunity' | 'OPPORTUNITY' | 'RECENT' | 'SOURCE' | 'TICKET' | 'TRANSCRIPT' | 'WITH' — How this document relates to the including entity. - `associatedEntityId` string — Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - `querySuggestion` QuerySuggestion - `missingTerm` string — A query term missing from the original query on which this suggestion is based. - `query` string, required — The query being suggested (e.g. enforcing the missing term from the original query). - `searchProviderInfo` SearchProviderInfo - … - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - … - `requestOptions` SearchRequestOptions - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - … - `inputDetails` SearchRequestInputDetails - … - `documents` Document[] — A truncated list of documents with this relation. TO BE DEPRECATED. - `id` string — The Glean Document ID. - `datasource` string — The app or other repository type from which the document was extracted - `connectorType` 'API_CRAWL' | 'BROWSER_CRAWL' | 'BROWSER_HISTORY' | 'BUILTIN' | 'FEDERATED_SEARCH' | 'PUSH_API' | 'WEB_CRAWL' | 'NATIVE_HISTORY' — The source from which document content was pulled, e.g. an API crawl or browser history - `docType` string — The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `content` DocumentContent - … - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - … - `sections` DocumentSection[] — A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - … - `results` SearchResult[] — A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - `structuredResults` StructuredResult[] — An array of entities in the work graph retrieved via a data request. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `document` Document - … - `title` string - `url` string, required - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - `snippets` SearchResultSnippet[] — Text content from the result document which contains search query terms, if available. - … - `fullText` string — 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). - `fullTextList` string[] — 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). - `relatedResults` RelatedDocuments[] — 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. - `clusteredResults` SearchResult[] — A list of results that should be displayed as associated with this result. - `allClusteredResults` ClusterGroup[] — A list of results that should be displayed as associated with this result. - … - `attachmentCount` integer — The total number of attachments. - `attachments` SearchResult[] — A (potentially partial) list of results representing documents attached to the main result document. - `backlinkResults` SearchResult[] — A list of results that should be displayed as backlinks of this result in reverse chronological order. - `clusterType` 'SIMILAR' | 'FRESHNESS' | 'TITLE' | 'CONTENT' | 'NONE' | 'THREAD_REPLY' | 'THREAD_ROOT' | 'PREFIX' | 'SUFFIX' | 'AUTHOR_PREFIX' | 'AUTHOR_SUFFIX' — The reason for inclusion of clusteredResults. - `mustIncludeSuggestions` QuerySuggestionList - … - `querySuggestion` QuerySuggestion - … - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `attachmentContext` string — Additional context for the relationship between the result and the document it's attached to. - `pins` PinDocument[] — A list of pins associated with this search result. - … - `metadata` PersonMetadata - `type` 'FULL_TIME' | 'CONTRACTOR' | 'NON_EMPLOYEE' | 'FORMER_EMPLOYEE' - `firstName` string — The first name of the person - `lastName` string — The last name of the person - `title` string — Job title. - `businessUnit` string — Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - `department` string — An organizational unit where everyone has a similar task, e.g. `Engineering`. - `jobFunction` string — Normalized job-function category assigned by Entity Builder from the source department and, when available, job title. Unlike `department`, which preserves the company-specific organizational unit, this field groups departments into configured categories such as `Engineering`, `Sales`, or `IT`; it may be `Unknown` when the mapping is inconclusive. - `teams` PersonTeam[] — Info about the employee's team(s). - `id` string — Unique identifier - `name` string — Team name - `externalLink` string, uri — Link to a team page on the internet or your company's intranet - `relationship` 'MEMBER' | 'MANAGER' | 'LEAD' | 'POINT_OF_CONTACT' | 'OTHER' — The team member's relationship to the team. This defaults to MEMBER if not set. - `joinDate` string, date-time — The team member's start date - `departmentCount` integer — The number of people in this person's department. - `email` string — The user's primary email address - `aliasEmails` string[] — Additional email addresses of this user beyond the primary, if any. - `location` string — User facing string representing the person's location. - `structuredLocation` StructuredLocation — Detailed location with information about country, state, city etc. - `deskLocation` string — Desk number. - `timezone` string — Location's timezone, e.g. UTC, PST. - `address` string — Office address or name. - `city` string — Name of the city. - `state` string — State code. - `region` string — Region information, e.g. NORAM, APAC. - `zipCode` string — ZIP Code for the address. - `country` string — Country name. - `countryCode` string — Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - `externalProfileLink` string — Link to a customer's internal profile page. This is set to '#' when no link is desired. - `manager` Person — recursive - `managementChain` Person[] — The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - `phone` string — Phone number as a number string. - `timezone` string — The timezone of the person. E.g. "Pacific Daylight Time". - `timezoneOffset` integer — The offset of the person's timezone in seconds from UTC. - `timezoneIANA` string — The IANA timezone identifier, e.g. "America/Los_Angeles". - `photoUrl` string, url — The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - `uneditedPhotoUrl` string, url — The original photo URL of the person's avatar before any edits they made are applied - `bannerUrl` string, url — The URL of the person's banner photo. - `reports` Person[] - `startDate` string, date — The date when the employee started. - `endDate` string, date — If a former employee, the last date of employment. - `bio` string — Short biography or mission statement of the employee. - `pronoun` string — She/her, He/his or other pronoun. - `orgSizeCount` integer — The total recursive size of the people reporting to this person, or 1 - `directReportsCount` integer — The total number of people who directly report to this person, or 0 - `preferredName` string — The preferred name of the person, or a nickname. - `socialNetwork` SocialNetwork[] — List of social network profiles. - `name` string, required — Possible values are "twitter", "linkedin". - `profileName` string — Human-readable profile name. - `profileUrl` string, url, required — Link to profile. - `datasourceProfile` DatasourceProfile[] — List of profiles this user has in different datasources / tools that they use. - `datasource` string, required — The datasource the profile is of. - `handle` string, required — The display name of the entity in the given datasource. - `url` string — URL to view the entity's profile. - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - `isUserGenerated` boolean — 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) - `querySuggestions` QuerySuggestionList - `suggestions` QuerySuggestion[] - … - `person` Person — recursive - `peopleDistance` PersonDistance[] — List of people and distances to those people from this person. Optionally with metadata. - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `distance` number, float, required — Distance to person, refer to PeopleDistance pipeline on interpretation of the value. - `inviteInfo` InviteInfo — Information regarding the invite status of a person. - `signUpTime` string, date-time — The time this person signed up in ISO format (ISO 8601). - `invites` ChannelInviteInfo[] — Latest invites received by the user for each channel - … - `inviter` Person — recursive - `inviteTime` string, date-time — The time this person was invited in ISO format (ISO 8601). - `reminderTime` string, date-time — The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - `isSignedUp` boolean — Whether the user has signed into Glean at least once. - `lastExtensionUse` string, date-time — The last time the user has used the Glean extension in ISO 8601 format. - `permissions` Permissions — 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. - `canAdminSearch` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch - `canAdminClientApiGlobalTokens` boolean — TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope - `canDlp` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features - `read` unknown - `write` unknown - `grant` unknown - `role` string — The roleId of the canonical role a user has. The displayName is equal to the roleId. - `roles` string[] — The roleIds of the roles a user has. - `customFields` CustomFieldData[] — User customizable fields for additional people information. - `label` string, required — A user-facing label for this field. - `values` CustomFieldValue[], required - … - `displayable` boolean, required — Determines whether the client should display this custom field - `loggingId` string — The logging id of the person used in scrubbed logs, tracking GA metrics. - `startDatePercentile` number, float — Percentage of the company that started strictly after this person. Between [0,100). - `busyEvents` AnonymousEvent[] — Intervals of busy time for this person, along with the type of event they're busy with. - `time` TimeInterval - … - `eventType` 'DEFAULT' | 'OUT_OF_OFFICE' — The nature of the event, for example "out of office". - `profileBoolSettings` object — flag settings to indicate user profile settings for certain items - `badges` Badge[] — The badges that a user has earned over their lifetime. - `key` string — An auto generated unique identifier. - `displayName` string — The badge name displayed to users - `iconConfig` IconConfig — Defines how to render an icon - … - `pinned` boolean — The badge should be shown on the PersonAttribution - `isOrgRoot` boolean — Whether this person is a "root" node in their organization's hierarchy. - `topUseCasesInsights` AgentUseCaseInsight[] - `useCase` string — Use case name - `runCount` integer — Total number of runs for this use case over the specified time period. - `trend` number, float — Percentage change in runs compared to the previous equivalent time period. - `topDepartments` string — Comma-separated list of the top departments using this use case. - `topAgentId` string — ID of the most-used agent for this use case. - `topAgentName` string — Name of the most-used agent for this use case. - `topAgentIcon` IconConfig — Defines how to render an icon - `generatedBackgroundColorKey` string - `backgroundColor` string - `color` string - `key` string - `iconType` 'COLLECTION' | 'CUSTOM' | 'DATASOURCE' | 'DATASOURCE_INSTANCE' | 'FAVICON' | 'FILE_TYPE' | 'GENERATED_BACKGROUND' | 'GLYPH' | 'MIME_TYPE' | 'NO_ICON' | 'PERSON' | 'REACTIONS' | 'URL' - `masked` boolean — Whether the icon should be masked based on current theme. - `name` string — The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - `url` string — The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - `topAgentIsDeleted` boolean — Indicates whether the top agent has been deleted. - `agentsUsageByDepartmentInsights` AgentsUsageByDepartmentInsight[] - `department` string — Name of the department - `agentAdoptionRate` number, float — Percentage of employees in the department who have used agents at least once over the specified time period. - `userCount` integer — Total number of users in this department who have used any agent over the specified time period. - `runCount` integer — Total number of runs in this department over the specified time period. - `agentId` string — ID of the agent to be shown in the agent column in this department over the specified time period. - `agentName` string — Name of the agent to be shown in the agent column in this department over the specified time period. - `icon` IconConfig — Defines how to render an icon - `generatedBackgroundColorKey` string - `backgroundColor` string - `color` string - `key` string - `iconType` 'COLLECTION' | 'CUSTOM' | 'DATASOURCE' | 'DATASOURCE_INSTANCE' | 'FAVICON' | 'FILE_TYPE' | 'GENERATED_BACKGROUND' | 'GLYPH' | 'MIME_TYPE' | 'NO_ICON' | 'PERSON' | 'REACTIONS' | 'URL' - `masked` boolean — Whether the icon should be masked based on current theme. - `name` string — The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - `url` string — The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - `isDeleted` boolean — Indicates whether the agent has been deleted - `agentUsersInsights` AgentUsersInsight[] - `person` Person - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `relatedDocuments` RelatedDocuments[] — A list of documents related to this person. - `relation` 'ATTACHMENT' | 'CANONICAL' | 'CASE' | 'contact' | 'CONTACT' | 'CONVERSATION_MESSAGES' | 'EXPERT' | 'FROM' | 'HIGHLIGHT' | 'opportunity' | 'OPPORTUNITY' | 'RECENT' | 'SOURCE' | 'TICKET' | 'TRANSCRIPT' | 'WITH' — How this document relates to the including entity. - `associatedEntityId` string — Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - `querySuggestion` QuerySuggestion - `missingTerm` string — A query term missing from the original query on which this suggestion is based. - `query` string, required — The query being suggested (e.g. enforcing the missing term from the original query). - `searchProviderInfo` SearchProviderInfo - … - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - … - `requestOptions` SearchRequestOptions - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - … - `inputDetails` SearchRequestInputDetails - … - `documents` Document[] — A truncated list of documents with this relation. TO BE DEPRECATED. - `id` string — The Glean Document ID. - `datasource` string — The app or other repository type from which the document was extracted - `connectorType` 'API_CRAWL' | 'BROWSER_CRAWL' | 'BROWSER_HISTORY' | 'BUILTIN' | 'FEDERATED_SEARCH' | 'PUSH_API' | 'WEB_CRAWL' | 'NATIVE_HISTORY' — The source from which document content was pulled, e.g. an API crawl or browser history - `docType` string — The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `content` DocumentContent - … - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - … - `sections` DocumentSection[] — A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - … - `results` SearchResult[] — A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - `structuredResults` StructuredResult[] — An array of entities in the work graph retrieved via a data request. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `document` Document - … - `title` string - `url` string, required - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - `snippets` SearchResultSnippet[] — Text content from the result document which contains search query terms, if available. - … - `fullText` string — 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). - `fullTextList` string[] — 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). - `relatedResults` RelatedDocuments[] — 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. - `clusteredResults` SearchResult[] — A list of results that should be displayed as associated with this result. - `allClusteredResults` ClusterGroup[] — A list of results that should be displayed as associated with this result. - … - `attachmentCount` integer — The total number of attachments. - `attachments` SearchResult[] — A (potentially partial) list of results representing documents attached to the main result document. - `backlinkResults` SearchResult[] — A list of results that should be displayed as backlinks of this result in reverse chronological order. - `clusterType` 'SIMILAR' | 'FRESHNESS' | 'TITLE' | 'CONTENT' | 'NONE' | 'THREAD_REPLY' | 'THREAD_ROOT' | 'PREFIX' | 'SUFFIX' | 'AUTHOR_PREFIX' | 'AUTHOR_SUFFIX' — The reason for inclusion of clusteredResults. - `mustIncludeSuggestions` QuerySuggestionList - … - `querySuggestion` QuerySuggestion - … - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `attachmentContext` string — Additional context for the relationship between the result and the document it's attached to. - `pins` PinDocument[] — A list of pins associated with this search result. - … - `metadata` PersonMetadata - `type` 'FULL_TIME' | 'CONTRACTOR' | 'NON_EMPLOYEE' | 'FORMER_EMPLOYEE' - `firstName` string — The first name of the person - `lastName` string — The last name of the person - `title` string — Job title. - `businessUnit` string — Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - `department` string — An organizational unit where everyone has a similar task, e.g. `Engineering`. - `jobFunction` string — Normalized job-function category assigned by Entity Builder from the source department and, when available, job title. Unlike `department`, which preserves the company-specific organizational unit, this field groups departments into configured categories such as `Engineering`, `Sales`, or `IT`; it may be `Unknown` when the mapping is inconclusive. - `teams` PersonTeam[] — Info about the employee's team(s). - `id` string — Unique identifier - `name` string — Team name - `externalLink` string, uri — Link to a team page on the internet or your company's intranet - `relationship` 'MEMBER' | 'MANAGER' | 'LEAD' | 'POINT_OF_CONTACT' | 'OTHER' — The team member's relationship to the team. This defaults to MEMBER if not set. - `joinDate` string, date-time — The team member's start date - `departmentCount` integer — The number of people in this person's department. - `email` string — The user's primary email address - `aliasEmails` string[] — Additional email addresses of this user beyond the primary, if any. - `location` string — User facing string representing the person's location. - `structuredLocation` StructuredLocation — Detailed location with information about country, state, city etc. - `deskLocation` string — Desk number. - `timezone` string — Location's timezone, e.g. UTC, PST. - `address` string — Office address or name. - `city` string — Name of the city. - `state` string — State code. - `region` string — Region information, e.g. NORAM, APAC. - `zipCode` string — ZIP Code for the address. - `country` string — Country name. - `countryCode` string — Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - `externalProfileLink` string — Link to a customer's internal profile page. This is set to '#' when no link is desired. - `manager` Person — recursive - `managementChain` Person[] — The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - `phone` string — Phone number as a number string. - `timezone` string — The timezone of the person. E.g. "Pacific Daylight Time". - `timezoneOffset` integer — The offset of the person's timezone in seconds from UTC. - `timezoneIANA` string — The IANA timezone identifier, e.g. "America/Los_Angeles". - `photoUrl` string, url — The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - `uneditedPhotoUrl` string, url — The original photo URL of the person's avatar before any edits they made are applied - `bannerUrl` string, url — The URL of the person's banner photo. - `reports` Person[] - `startDate` string, date — The date when the employee started. - `endDate` string, date — If a former employee, the last date of employment. - `bio` string — Short biography or mission statement of the employee. - `pronoun` string — She/her, He/his or other pronoun. - `orgSizeCount` integer — The total recursive size of the people reporting to this person, or 1 - `directReportsCount` integer — The total number of people who directly report to this person, or 0 - `preferredName` string — The preferred name of the person, or a nickname. - `socialNetwork` SocialNetwork[] — List of social network profiles. - `name` string, required — Possible values are "twitter", "linkedin". - `profileName` string — Human-readable profile name. - `profileUrl` string, url, required — Link to profile. - `datasourceProfile` DatasourceProfile[] — List of profiles this user has in different datasources / tools that they use. - `datasource` string, required — The datasource the profile is of. - `handle` string, required — The display name of the entity in the given datasource. - `url` string — URL to view the entity's profile. - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - `isUserGenerated` boolean — 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) - `querySuggestions` QuerySuggestionList - `suggestions` QuerySuggestion[] - … - `person` Person — recursive - `peopleDistance` PersonDistance[] — List of people and distances to those people from this person. Optionally with metadata. - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `distance` number, float, required — Distance to person, refer to PeopleDistance pipeline on interpretation of the value. - `inviteInfo` InviteInfo — Information regarding the invite status of a person. - `signUpTime` string, date-time — The time this person signed up in ISO format (ISO 8601). - `invites` ChannelInviteInfo[] — Latest invites received by the user for each channel - … - `inviter` Person — recursive - `inviteTime` string, date-time — The time this person was invited in ISO format (ISO 8601). - `reminderTime` string, date-time — The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - `isSignedUp` boolean — Whether the user has signed into Glean at least once. - `lastExtensionUse` string, date-time — The last time the user has used the Glean extension in ISO 8601 format. - `permissions` Permissions — 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. - `canAdminSearch` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch - `canAdminClientApiGlobalTokens` boolean — TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope - `canDlp` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features - `read` unknown - `write` unknown - `grant` unknown - `role` string — The roleId of the canonical role a user has. The displayName is equal to the roleId. - `roles` string[] — The roleIds of the roles a user has. - `customFields` CustomFieldData[] — User customizable fields for additional people information. - `label` string, required — A user-facing label for this field. - `values` CustomFieldValue[], required - … - `displayable` boolean, required — Determines whether the client should display this custom field - `loggingId` string — The logging id of the person used in scrubbed logs, tracking GA metrics. - `startDatePercentile` number, float — Percentage of the company that started strictly after this person. Between [0,100). - `busyEvents` AnonymousEvent[] — Intervals of busy time for this person, along with the type of event they're busy with. - `time` TimeInterval - … - `eventType` 'DEFAULT' | 'OUT_OF_OFFICE' — The nature of the event, for example "out of office". - `profileBoolSettings` object — flag settings to indicate user profile settings for certain items - `badges` Badge[] — The badges that a user has earned over their lifetime. - `key` string — An auto generated unique identifier. - `displayName` string — The badge name displayed to users - `iconConfig` IconConfig — Defines how to render an icon - … - `pinned` boolean — The badge should be shown on the PersonAttribution - `isOrgRoot` boolean — Whether this person is a "root" node in their organization's hierarchy. - `departmentName` string — Department name - `agentsUsedCount` integer — Total number of agents used by this user over the specified time period. - `averageRunsPerDayCount` number, float — Average number of runs per day for this user over the specified time period. - `agentsCreatedCount` integer — Total number of agents created by this user over the specified time period. - `runCount` integer — Total number of agent runs for this user over the specified time period. - `agentsTimeSavedInsights` AgentsTimeSavedInsight[] — Insights for agents time saved over the specified time period. - `agentId` string — Agent ID - `agentName` string — Agent name - `icon` IconConfig — Defines how to render an icon - `generatedBackgroundColorKey` string - `backgroundColor` string - `color` string - `key` string - `iconType` 'COLLECTION' | 'CUSTOM' | 'DATASOURCE' | 'DATASOURCE_INSTANCE' | 'FAVICON' | 'FILE_TYPE' | 'GENERATED_BACKGROUND' | 'GLYPH' | 'MIME_TYPE' | 'NO_ICON' | 'PERSON' | 'REACTIONS' | 'URL' - `masked` boolean — Whether the icon should be masked based on current theme. - `name` string — The name of the icon if applicable, e.g. the glyph name for `IconType.GLYPH` icons. - `url` string — The URL to an image to be displayed if applicable, e.g. the URL for `iconType.URL` icons. - `isDeleted` boolean — Indicates whether the agent has been deleted - `runCount` integer — Total number of runs for this agent over the specified time period. - `minsPerRun` number, float — Average minutes saved per run for this agent over the specified time period. - `feedbackUserCount` integer — Total number of users who provided feedback on time saved for this agent over the specified time period. - `dailyAgentRunsTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `successfulRunsTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `failedRunsTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `pausedRunsTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `upvotesTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `downvotesTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `mcpResponse` McpInsightsResponse - `monthlyActiveUsers` integer — Number of current Monthly Active Users. - `weeklyActiveUsers` integer — Number of current Weekly Active Users. - `dailyActiveUsers` integer — Number of current Daily Active Users. - `monthlyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `weeklyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `dailyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `overallDailyActiveUserTimeseries` LabeledCountInfo - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `topHostApplicationsActiveUserTimeseries` LabeledCountInfo[] - `label` string, required — Label for the included count information. - `countInfo` CountInfo[] — List of data points for counts for a given date period. - `count` integer, required — The counter value - `period` Period - `minDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define upper boundary of time period. - `maxDaysFromNow` integer — DEPRECATED - The number of days from now in the past to define lower boundary of time period. - `start` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `end` TimePoint - `epochSeconds` integer — Epoch seconds. Has precedence over daysFromNow. - `daysFromNow` integer — Number of days in the past, relative to the current date. - `org` string — The unit of organization over which we did the count aggregation, e.g. org (department) or company - `mcpBreakdownResponse` McpBreakdownInsightsResponse - `usersBreakdown` McpUserBreakdown[] - `person` Person - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `relatedDocuments` RelatedDocuments[] — A list of documents related to this person. - `relation` 'ATTACHMENT' | 'CANONICAL' | 'CASE' | 'contact' | 'CONTACT' | 'CONVERSATION_MESSAGES' | 'EXPERT' | 'FROM' | 'HIGHLIGHT' | 'opportunity' | 'OPPORTUNITY' | 'RECENT' | 'SOURCE' | 'TICKET' | 'TRANSCRIPT' | 'WITH' — How this document relates to the including entity. - `associatedEntityId` string — Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) - `querySuggestion` QuerySuggestion - `missingTerm` string — A query term missing from the original query on which this suggestion is based. - `query` string, required — The query being suggested (e.g. enforcing the missing term from the original query). - `searchProviderInfo` SearchProviderInfo - … - `label` string — A user-facing description to display for the suggestion. - `datasource` string — The datasource associated with the suggestion. - `resultTab` ResultTab - … - `requestOptions` SearchRequestOptions - … - `ranges` TextRange[] — The bolded ranges within the query of the QuerySuggestion. - … - `inputDetails` SearchRequestInputDetails - … - `documents` Document[] — A truncated list of documents with this relation. TO BE DEPRECATED. - `id` string — The Glean Document ID. - `datasource` string — The app or other repository type from which the document was extracted - `connectorType` 'API_CRAWL' | 'BROWSER_CRAWL' | 'BROWSER_HISTORY' | 'BUILTIN' | 'FEDERATED_SEARCH' | 'PUSH_API' | 'WEB_CRAWL' | 'NATIVE_HISTORY' — The source from which document content was pulled, e.g. an API crawl or browser history - `docType` string — The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). - `content` DocumentContent - … - `containerDocument` Document — recursive - `parentDocument` Document — recursive - `title` string — The title of the document. - `url` string — A permalink for the document. - `metadata` DocumentMetadata - … - `sections` DocumentSection[] — A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. - … - `results` SearchResult[] — A truncated list of documents associated with this relation. To be used in favor of `documents` because it contains a trackingToken. - `structuredResults` StructuredResult[] — An array of entities in the work graph retrieved via a data request. - … - `trackingToken` string — An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. - `document` Document - … - `title` string - `url` string, required - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). - `snippets` SearchResultSnippet[] — Text content from the result document which contains search query terms, if available. - … - `fullText` string — 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). - `fullTextList` string[] — 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). - `relatedResults` RelatedDocuments[] — 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. - `clusteredResults` SearchResult[] — A list of results that should be displayed as associated with this result. - `allClusteredResults` ClusterGroup[] — A list of results that should be displayed as associated with this result. - … - `attachmentCount` integer — The total number of attachments. - `attachments` SearchResult[] — A (potentially partial) list of results representing documents attached to the main result document. - `backlinkResults` SearchResult[] — A list of results that should be displayed as backlinks of this result in reverse chronological order. - `clusterType` 'SIMILAR' | 'FRESHNESS' | 'TITLE' | 'CONTENT' | 'NONE' | 'THREAD_REPLY' | 'THREAD_ROOT' | 'PREFIX' | 'SUFFIX' | 'AUTHOR_PREFIX' | 'AUTHOR_SUFFIX' — The reason for inclusion of clusteredResults. - `mustIncludeSuggestions` QuerySuggestionList - … - `querySuggestion` QuerySuggestion - … - `prominence` 'HERO' | 'PROMOTED' | 'STANDARD' — The level of visual distinction that should be given to a result. - `attachmentContext` string — Additional context for the relationship between the result and the document it's attached to. - `pins` PinDocument[] — A list of pins associated with this search result. - … - `metadata` PersonMetadata - `type` 'FULL_TIME' | 'CONTRACTOR' | 'NON_EMPLOYEE' | 'FORMER_EMPLOYEE' - `firstName` string — The first name of the person - `lastName` string — The last name of the person - `title` string — Job title. - `businessUnit` string — Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses. - `department` string — An organizational unit where everyone has a similar task, e.g. `Engineering`. - `jobFunction` string — Normalized job-function category assigned by Entity Builder from the source department and, when available, job title. Unlike `department`, which preserves the company-specific organizational unit, this field groups departments into configured categories such as `Engineering`, `Sales`, or `IT`; it may be `Unknown` when the mapping is inconclusive. - `teams` PersonTeam[] — Info about the employee's team(s). - `id` string — Unique identifier - `name` string — Team name - `externalLink` string, uri — Link to a team page on the internet or your company's intranet - `relationship` 'MEMBER' | 'MANAGER' | 'LEAD' | 'POINT_OF_CONTACT' | 'OTHER' — The team member's relationship to the team. This defaults to MEMBER if not set. - `joinDate` string, date-time — The team member's start date - `departmentCount` integer — The number of people in this person's department. - `email` string — The user's primary email address - `aliasEmails` string[] — Additional email addresses of this user beyond the primary, if any. - `location` string — User facing string representing the person's location. - `structuredLocation` StructuredLocation — Detailed location with information about country, state, city etc. - `deskLocation` string — Desk number. - `timezone` string — Location's timezone, e.g. UTC, PST. - `address` string — Office address or name. - `city` string — Name of the city. - `state` string — State code. - `region` string — Region information, e.g. NORAM, APAC. - `zipCode` string — ZIP Code for the address. - `country` string — Country name. - `countryCode` string — Alpha-2 or Alpha-3 ISO 3166 country code, e.g. US or USA. - `externalProfileLink` string — Link to a customer's internal profile page. This is set to '#' when no link is desired. - `manager` Person — recursive - `managementChain` Person[] — The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager. - `phone` string — Phone number as a number string. - `timezone` string — The timezone of the person. E.g. "Pacific Daylight Time". - `timezoneOffset` integer — The offset of the person's timezone in seconds from UTC. - `timezoneIANA` string — The IANA timezone identifier, e.g. "America/Los_Angeles". - `photoUrl` string, url — The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). - `uneditedPhotoUrl` string, url — The original photo URL of the person's avatar before any edits they made are applied - `bannerUrl` string, url — The URL of the person's banner photo. - `reports` Person[] - `startDate` string, date — The date when the employee started. - `endDate` string, date — If a former employee, the last date of employment. - `bio` string — Short biography or mission statement of the employee. - `pronoun` string — She/her, He/his or other pronoun. - `orgSizeCount` integer — The total recursive size of the people reporting to this person, or 1 - `directReportsCount` integer — The total number of people who directly report to this person, or 0 - `preferredName` string — The preferred name of the person, or a nickname. - `socialNetwork` SocialNetwork[] — List of social network profiles. - `name` string, required — Possible values are "twitter", "linkedin". - `profileName` string — Human-readable profile name. - `profileUrl` string, url, required — Link to profile. - `datasourceProfile` DatasourceProfile[] — List of profiles this user has in different datasources / tools that they use. - `datasource` string, required — The datasource the profile is of. - `handle` string, required — The display name of the entity in the given datasource. - `url` string — URL to view the entity's profile. - `nativeAppUrl` string — A deep link, if available, into the datasource's native application for the entity's platform (i.e. slack://...). - `isUserGenerated` boolean — 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) - `querySuggestions` QuerySuggestionList - `suggestions` QuerySuggestion[] - … - `person` Person — recursive - `peopleDistance` PersonDistance[] — List of people and distances to those people from this person. Optionally with metadata. - `name` string, required — The display name. - `obfuscatedId` string, required — An opaque identifier that can be used to request metadata for a Person. - `distance` number, float, required — Distance to person, refer to PeopleDistance pipeline on interpretation of the value. - `inviteInfo` InviteInfo — Information regarding the invite status of a person. - `signUpTime` string, date-time — The time this person signed up in ISO format (ISO 8601). - `invites` ChannelInviteInfo[] — Latest invites received by the user for each channel - … - `inviter` Person — recursive - `inviteTime` string, date-time — The time this person was invited in ISO format (ISO 8601). - `reminderTime` string, date-time — The time this person was reminded in ISO format (ISO 8601) if a reminder was sent. - `isSignedUp` boolean — Whether the user has signed into Glean at least once. - `lastExtensionUse` string, date-time — The last time the user has used the Glean extension in ISO 8601 format. - `permissions` Permissions — 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. - `canAdminSearch` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to /adminsearch - `canAdminClientApiGlobalTokens` boolean — TODO--deprecate in favor of the read and write properties. True if the user can administrate client API tokens with global scope - `canDlp` boolean — TODO--deprecate in favor of the read and write properties. True if the user has access to data loss prevention (DLP) features - `read` unknown - `write` unknown - `grant` unknown - `role` string — The roleId of the canonical role a user has. The displayName is equal to the roleId. - `roles` string[] — The roleIds of the roles a user has. - `customFields` CustomFieldData[] — User customizable fields for additional people information. - `label` string, required — A user-facing label for this field. - `values` CustomFieldValue[], required - … - `displayable` boolean, required — Determines whether the client should display this custom field - `loggingId` string — The logging id of the person used in scrubbed logs, tracking GA metrics. - `startDatePercentile` number, float — Percentage of the company that started strictly after this person. Between [0,100). - `busyEvents` AnonymousEvent[] — Intervals of busy time for this person, along with the type of event they're busy with. - `time` TimeInterval - … - `eventType` 'DEFAULT' | 'OUT_OF_OFFICE' — The nature of the event, for example "out of office". - `profileBoolSettings` object — flag settings to indicate user profile settings for certain items - `badges` Badge[] — The badges that a user has earned over their lifetime. - `key` string — An auto generated unique identifier. - `displayName` string — The badge name displayed to users - `iconConfig` IconConfig — Defines how to render an icon - … - `pinned` boolean — The badge should be shown on the PersonAttribution - `isOrgRoot` boolean — Whether this person is a "root" node in their organization's hierarchy. - `totalCalls` integer — Total number of MCP calls made by this user in the specified time period. - `hostApplications` string[] — Host applications used by this user in the specified time period. - `tools` string[] — MCP tools used by this user in the specified time period. - `servers` string[] — MCP servers used by this user in the specified time period. - `hostApplicationsBreakdown` McpHostApplicationBreakdown[] - `hostApplication` string — Host application name. - `totalCalls` integer — Total number of MCP calls made from this host application in the specified time period. - `activeUsers` integer — Total number of active users from this host application in the specified time period. - `toolsBreakdown` McpToolBreakdown[] - `tool` string — MCP tool name. - `totalCalls` integer — Total number of MCP calls for this tool in the specified time period. - `activeUsers` integer — Total number of active users for this tool in the specified time period. - `hostApplications` string[] — Host applications using this tool in the specified time period. - `serversBreakdown` McpServerBreakdown[] - `server` string — MCP server name. - `totalCalls` integer — Total number of MCP calls for this server in the specified time period. - `activeUsers` integer — Total number of active users for this server in the specified time period. - `hostApplications` string[] — Host applications using this server in the specified time period. ## Other responses - `400` — Invalid request - `401` — Not Authorized - `429` — Too Many Requests --- [API](https://skmtc.net/gleanwork/apis/glean-api.md) · [All operations](https://skmtc.net/gleanwork/apis/glean-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gleanwork/glean-api/revisions/ebd602e4aea4/schema)