# Worklytics Documentation ## Worklytics Documentation - [Overview](https://docs.worklytics.co/knowledge-base/readme.md) - [Access Control](https://docs.worklytics.co/knowledge-base/access-control.md) - [Single Sign-On](https://docs.worklytics.co/knowledge-base/access-control/identity-providers.md) - [Okta](https://docs.worklytics.co/knowledge-base/access-control/identity-providers/okta.md) - [SAML](https://docs.worklytics.co/knowledge-base/access-control/identity-providers/saml.md) - [Configuration](https://docs.worklytics.co/knowledge-base/configuration.md) - [Analytics](https://docs.worklytics.co/knowledge-base/configuration/analytics.md) - [Data Protection](https://docs.worklytics.co/knowledge-base/configuration/data-protection.md) - [Data Import](https://docs.worklytics.co/knowledge-base/data-import.md) - [API](https://docs.worklytics.co/knowledge-base/data-import/api.md) - [Bulk](https://docs.worklytics.co/knowledge-base/data-import/bulk.md) - [Amazon S3](https://docs.worklytics.co/knowledge-base/data-import/bulk/s3.md) - [Google Cloud Storage™](https://docs.worklytics.co/knowledge-base/data-import/bulk/gcs.md) - [Azure Blob Storage](https://docs.worklytics.co/knowledge-base/data-import/bulk/azure-blob.md) - [Webhooks](https://docs.worklytics.co/knowledge-base/data-import/webhooks.md) - [Proxy vs Direct](https://docs.worklytics.co/knowledge-base/data-import/proxy-vs-direct.md) - [Data Dictionary](https://docs.worklytics.co/knowledge-base/data-dictionary.md) - [Dataset Overview](https://docs.worklytics.co/knowledge-base/data-dictionary/dataset-overview.md) - [Aggregate Metrics](https://docs.worklytics.co/knowledge-base/data-dictionary/weekly-aggregates-table.md) - [AI Metrics](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-aggregates-table.md) - [Getting Started](https://docs.worklytics.co/knowledge-base/data-dictionary/getting-started.md) - [Worklytics Datasets](https://docs.worklytics.co/knowledge-base/data-dictionary/getting-started/worklytics-datasets.md) - [Your First 2 SQL Queries](https://docs.worklytics.co/knowledge-base/data-dictionary/getting-started/your-first-2-sql-queries.md) - [Sample SQL Queries: Aggregate-Level Data & Collab. Graph](https://docs.worklytics.co/knowledge-base/data-dictionary/getting-started/sample-sql-queries-aggregate-level-data-and-collab.-graph.md) - [Sample SQL Queries: Event-Level Data](https://docs.worklytics.co/knowledge-base/data-dictionary/getting-started/sample-sql-queries-event-level-data.md) - [Sample SQL Queries: Manager Effectiveness](https://docs.worklytics.co/knowledge-base/data-dictionary/getting-started/sample-sql-queries-event-level-data-1.md) - [Sample SQL Queries: Meeting Effectiveness](https://docs.worklytics.co/knowledge-base/data-dictionary/getting-started/sample-sql-queries-event-level-data-2.md) - [Sample SQL Queries: Remote & Hybrid Work](https://docs.worklytics.co/knowledge-base/data-dictionary/getting-started/sample-sql-queries-event-level-data-3.md) - [Sample SQL Queries: Sales Effectiveness](https://docs.worklytics.co/knowledge-base/data-dictionary/getting-started/sample-sql-queries-event-level-data-4.md) - [Aggregates Methodology](https://docs.worklytics.co/knowledge-base/data-dictionary/aggregates-methodology.md) - [Focus Time Methodology](https://docs.worklytics.co/knowledge-base/data-dictionary/aggregates-methodology/focus-time-methodology.md) - [AI Methodology](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology.md) - [Defining AI Usage](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/defining-ai-usage.md) - [Worklytics vs. Tool-Reported Data](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/worklytics-vs-self-reported.md) - [Tools](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison.md) - [ChatGPT Enterprise](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/chatgpt.md) - [Claude](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/claude-assistant.md) - [Gemini in Workspace](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/gemini.md) - [Microsoft Copilot](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/microsoft-copilot.md) - [Slack AI](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/slack-ai.md) - [GitHub Copilot](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/github-copilot.md) - [Claude Code](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/claude-code.md) - [Cursor](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/cursor.md) - [Windsurf](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/windsurf.md) - [Glean](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/glean.md) - [Miro AI](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/miro-ai.md) - [Gong](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/gong.md) - [Atlassian Rovo](https://docs.worklytics.co/knowledge-base/data-dictionary/ai-methodology/tool-comparison/atlassian-rovo.md) - [Analysis Guides](https://docs.worklytics.co/knowledge-base/data-dictionary/analysis-guides.md) - [Guidelines v. Benchmarks](https://docs.worklytics.co/knowledge-base/data-dictionary/analysis-guides/guidelines-v.-benchmarks.md) - [Visualizing metrics via jitter plots](https://docs.worklytics.co/knowledge-base/data-dictionary/analysis-guides/visualizing-metrics-via-jitter-plots.md) - [Driver analysis using Worklytics metrics](https://docs.worklytics.co/knowledge-base/data-dictionary/analysis-guides/driver-analysis-using-worklytics-metrics.md) - [Common hypotheses for survey driver analysis](https://docs.worklytics.co/knowledge-base/data-dictionary/analysis-guides/common-hypotheses-for-survey-driver-analysis.md) - [Meeting effectiveness analysis](https://docs.worklytics.co/knowledge-base/data-dictionary/analysis-guides/meeting-effectiveness-analysis.md) - [Understanding manager facetime](https://docs.worklytics.co/knowledge-base/data-dictionary/analysis-guides/understanding-manager-facetime.md) - [Frequently Asked Questions](https://docs.worklytics.co/knowledge-base/data-dictionary/frequently-asked-questions.md) - [Data Sources](https://docs.worklytics.co/knowledge-base/connectors.md) - [Asana](https://docs.worklytics.co/knowledge-base/connectors/asana.md) - [Direct Connection](https://docs.worklytics.co/knowledge-base/connectors/asana/direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/asana/asana.md) - [Atlassian Organization](https://docs.worklytics.co/knowledge-base/connectors/organization.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/organization/atlassian-organization.md) - [Badge Data](https://docs.worklytics.co/knowledge-base/connectors/badge.md) - [Bitbucket](https://docs.worklytics.co/knowledge-base/connectors/bitbucket.md) - [Bulk Data](https://docs.worklytics.co/knowledge-base/connectors/bulk-data.md) - [HRIS / HCM Data](https://docs.worklytics.co/knowledge-base/connectors/bulk-data/hris-snapshots.md) - [Survey Data](https://docs.worklytics.co/knowledge-base/connectors/bulk-data/survey.md) - [AI Tool Usage Bulk](https://docs.worklytics.co/knowledge-base/connectors/bulk-data/ai-bulk.md) - [ChatGPT Enterprise](https://docs.worklytics.co/knowledge-base/connectors/chatgpt.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/chatgpt/chatgpt-enterprise.md) - [Claude](https://docs.worklytics.co/knowledge-base/connectors/claude.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/claude/claude.md) - [Claude Code](https://docs.worklytics.co/knowledge-base/connectors/claude-code.md) - [Claude Code Bulk](https://docs.worklytics.co/knowledge-base/connectors/claude-code/claude-bulk.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/claude-code/claude-code.md) - [Claude Enterprise Analytics](https://docs.worklytics.co/knowledge-base/connectors/claude-enterprise-analytics.md) - [Codex Enterprise Analytics](https://docs.worklytics.co/knowledge-base/connectors/codex-enterprise-analytics.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/codex-enterprise-analytics/codex-enterprise-analytics.md) - [Cursor](https://docs.worklytics.co/knowledge-base/connectors/cursor.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/cursor/cursor.md) - [Gemini™ in Workspace Apps](https://docs.worklytics.co/knowledge-base/connectors/gemini-in-workspace-apps.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/gemini-in-workspace-apps/direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/gemini-in-workspace-apps/gemini-in-workspace-apps.md) - [GenAI Portals](https://docs.worklytics.co/knowledge-base/connectors/gen-ai-portal.md) - [GitHub](https://docs.worklytics.co/knowledge-base/connectors/github.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/github/github.md) - [GitHub Copilot](https://docs.worklytics.co/knowledge-base/connectors/github-copilot.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/github-copilot/github-copilot.md) - [Gitlab](https://docs.worklytics.co/knowledge-base/connectors/gitlab.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/gitlab/gitlab.md) - [Glean](https://docs.worklytics.co/knowledge-base/connectors/glean.md) - [Customer Events Log](https://docs.worklytics.co/knowledge-base/connectors/glean/glean-customer-events-log-bulk.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/glean/glean.md) - [Gmail™](https://docs.worklytics.co/knowledge-base/connectors/gmail.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/gmail/gmail-meta-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/gmail/gmail.md) - [Gong](https://docs.worklytics.co/knowledge-base/connectors/gong.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/gong/gong.md) - [Google Calendar™](https://docs.worklytics.co/knowledge-base/connectors/google-calendar.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/google-calendar/google-calendar-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/google-calendar/google-calendar.md) - [Google Chat™](https://docs.worklytics.co/knowledge-base/connectors/google-chat.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/google-chat/google-chat-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/google-chat/google-chat.md) - [Google Drive™](https://docs.worklytics.co/knowledge-base/connectors/google-drive.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/google-drive/google-drive-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/google-drive/google-drive.md) - [Google Meet™](https://docs.worklytics.co/knowledge-base/connectors/google-meet.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/google-meet/google-meet-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/google-meet/google-meet.md) - [Google Workspace™ Directory](https://docs.worklytics.co/knowledge-base/connectors/google-directory.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/google-directory/google-directory-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/google-directory/google-workspace-directory.md) - [Jira](https://docs.worklytics.co/knowledge-base/connectors/jira.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/jira/atlassian-jira-cloud.md) - [Microsoft Copilot](https://docs.worklytics.co/knowledge-base/connectors/copilot.md) - [Direct Connection](https://docs.worklytics.co/knowledge-base/connectors/copilot/copilot-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/copilot/microsoft-copilot.md) - [Microsoft Direct Connections Advanced Configuration](https://docs.worklytics.co/knowledge-base/connectors/direct-connection.md) - [Microsoft Entra ID](https://docs.worklytics.co/knowledge-base/connectors/azure-ad.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/azure-ad/azure-ad-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/azure-ad/entra-id.md) - [Microsoft OneDrive](https://docs.worklytics.co/knowledge-base/connectors/onedrive.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/onedrive/onedrive-direct-connection.md) - [Microsoft Outlook Calendar](https://docs.worklytics.co/knowledge-base/connectors/outlook-calendar.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/outlook-calendar/outlook-calendar-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/outlook-calendar/outlook-calendar.md) - [Microsoft Outlook Mail](https://docs.worklytics.co/knowledge-base/connectors/outlook-mail.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/outlook-mail/outlook-mail-direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/outlook-mail/outlook-mail.md) - [Microsoft Teams](https://docs.worklytics.co/knowledge-base/connectors/teams.md) - [Direct Connections](https://docs.worklytics.co/knowledge-base/connectors/teams/teams-direct-connection.md) - [Proxy Connection](https://docs.worklytics.co/knowledge-base/connectors/teams/teams-proxy-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/teams/microsoft-teams.md) - [Miro](https://docs.worklytics.co/knowledge-base/connectors/miro.md) - [Salesforce](https://docs.worklytics.co/knowledge-base/connectors/salesforce.md) - [Salesforce Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/salesforce/salesforce.md) - [Sales for Copilot](https://docs.worklytics.co/knowledge-base/connectors/salesforce/sales-copilot.md) - [Slack](https://docs.worklytics.co/knowledge-base/connectors/slack.md) - [Direct Connection](https://docs.worklytics.co/knowledge-base/connectors/slack/direct-connection.md) - [Slack AI Analytics - Bulk](https://docs.worklytics.co/knowledge-base/connectors/slack/slack-ai-analytics-bulk.md) - [Slack AI Snapshot](https://docs.worklytics.co/knowledge-base/connectors/slack/slack-ai-snapshot.md) - [Slack Exports](https://docs.worklytics.co/knowledge-base/connectors/slack/slack-discovery.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/slack/slack.md) - [Windsurf](https://docs.worklytics.co/knowledge-base/connectors/windsurf.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/windsurf/windsurf.md) - [Work Data (generic)](https://docs.worklytics.co/knowledge-base/connectors/work-data-generic.md) - [Zoom](https://docs.worklytics.co/knowledge-base/connectors/zoom.md) - [Direct Connection](https://docs.worklytics.co/knowledge-base/connectors/zoom/direct-connection.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/connectors/zoom/zoom.md) - [Data Export](https://docs.worklytics.co/knowledge-base/data-export.md) - [Weekly Aggregates](https://docs.worklytics.co/knowledge-base/data-export/weekly-aggregates.md) - [Customer Audit](https://docs.worklytics.co/knowledge-base/data-export/customer-audit.md) - [Collaboration](https://docs.worklytics.co/knowledge-base/data-export/collaboration.md) - [Employee Events](https://docs.worklytics.co/knowledge-base/data-export/employee-events.md) - [Work Items](https://docs.worklytics.co/knowledge-base/data-export/items.md) - [Benchmarks](https://docs.worklytics.co/knowledge-base/data-export/benchmarks.md) - [Dashboard Data Export](https://docs.worklytics.co/knowledge-base/data-export/tableau-data-export.md) - [How to export data to Cloud Storage Providers](https://docs.worklytics.co/knowledge-base/data-export/cloud-storage-providers.md) - [Amazon Web Services (AWS) S3](https://docs.worklytics.co/knowledge-base/data-export/cloud-storage-providers/aws-s3.md) - [Azure Blob Storage](https://docs.worklytics.co/knowledge-base/data-export/cloud-storage-providers/azure.md) - [Google Cloud Storage™ (GCS)](https://docs.worklytics.co/knowledge-base/data-export/cloud-storage-providers/google-cloud-storage.md) - [Data Inventory](https://docs.worklytics.co/knowledge-base/data-inventory.md) - [Asana](https://docs.worklytics.co/knowledge-base/data-inventory/asana-sanitized.md) - [Atlassian Organization](https://docs.worklytics.co/knowledge-base/data-inventory/atlassian-organization-sanitized.md) - [ChatGPT Enterprise](https://docs.worklytics.co/knowledge-base/data-inventory/chatgpt-enterprise-sanitized.md) - [Claude](https://docs.worklytics.co/knowledge-base/data-inventory/claude-sanitized.md) - [Claude Code](https://docs.worklytics.co/knowledge-base/data-inventory/claude-code-sanitized.md) - [Claude Enterprise Analytics](https://docs.worklytics.co/knowledge-base/data-inventory/claude-enterprise-analytics-sanitized.md) - [Confluence](https://docs.worklytics.co/knowledge-base/data-inventory/confluence-sanitized.md) - [Cursor](https://docs.worklytics.co/knowledge-base/data-inventory/cursor-sanitized.md) - [Gemini™ in Workspace Apps](https://docs.worklytics.co/knowledge-base/data-inventory/gemini-in-workspace-apps-sanitized.md) - [GitHub](https://docs.worklytics.co/knowledge-base/data-inventory/github-sanitized.md) - [GitHub Copilot](https://docs.worklytics.co/knowledge-base/data-inventory/github-copilot-sanitized.md) - [GitLab](https://docs.worklytics.co/knowledge-base/data-inventory/gitlab-sanitized.md) - [Glean](https://docs.worklytics.co/knowledge-base/data-inventory/glean-sanitized.md) - [Gmail™](https://docs.worklytics.co/knowledge-base/data-inventory/gmail-sanitized.md) - [Gong](https://docs.worklytics.co/knowledge-base/data-inventory/gong-sanitized.md) - [Google Calendar™](https://docs.worklytics.co/knowledge-base/data-inventory/google-calendar-sanitized.md) - [Google Chat™](https://docs.worklytics.co/knowledge-base/data-inventory/google-chat-sanitized.md) - [Google Drive™](https://docs.worklytics.co/knowledge-base/data-inventory/google-drive-sanitized.md) - [Google Meet™](https://docs.worklytics.co/knowledge-base/data-inventory/google-meet-sanitized.md) - [Google Workspace™ Directory](https://docs.worklytics.co/knowledge-base/data-inventory/google-workspace-directory-sanitized.md) - [Jira](https://docs.worklytics.co/knowledge-base/data-inventory/atlassian-jira-cloud-sanitized.md) - [Microsoft Copilot](https://docs.worklytics.co/knowledge-base/data-inventory/microsoft-copilot-sanitized.md) - [Microsoft Entra ID](https://docs.worklytics.co/knowledge-base/data-inventory/entra-id-sanitized.md) - [Microsoft Teams](https://docs.worklytics.co/knowledge-base/data-inventory/microsoft-teams-sanitized.md) - [Outlook Calendar](https://docs.worklytics.co/knowledge-base/data-inventory/outlook-calendar-sanitized.md) - [Outlook Mail](https://docs.worklytics.co/knowledge-base/data-inventory/outlook-mail-sanitized.md) - [Salesforce](https://docs.worklytics.co/knowledge-base/data-inventory/salesforce-sanitized.md) - [Slack](https://docs.worklytics.co/knowledge-base/data-inventory/slack-sanitized.md) - [Windsurf](https://docs.worklytics.co/knowledge-base/data-inventory/windsurf-sanitized.md) - [Zoom](https://docs.worklytics.co/knowledge-base/data-inventory/zoom-sanitized.md) - [Tenant API](https://docs.worklytics.co/knowledge-base/tenant-api.md) - [Worklytics Dashboard Overview](https://docs.worklytics.co/knowledge-base/worklytics-dashboard-overview.md) - [Release Notes](https://docs.worklytics.co/knowledge-base/release-notes.md) - [2025-12: Workday Overlap and Timezone Offset Metrics](https://docs.worklytics.co/knowledge-base/release-notes/2025-12-workday-overlap-and-timezone-offset-metrics.md): New Cross-Timezone Collaboration Metrics - [2025-10: Advanced Permissions](https://docs.worklytics.co/knowledge-base/release-notes/2025-10-release-notes-advanced-permissions.md) - [2025-08: New AI Connectors](https://docs.worklytics.co/knowledge-base/release-notes/2025-08-new-ai-connectors.md) - [2025-07: Introducing our Workplace Insights Dashboard](https://docs.worklytics.co/knowledge-base/release-notes/2025-07-introducing-our-workplace-insights-dashboard.md) - [2025-05: In-Meeting Redundancy Metrics](https://docs.worklytics.co/knowledge-base/release-notes/2025-05-in-meeting-redundancy-metrics.md) - [2025-02: Advanced Benchmarks V2](https://docs.worklytics.co/knowledge-base/release-notes/2025-02-advanced-benchmarks-v2.md) - [2024-10: Data Science Resources](https://docs.worklytics.co/knowledge-base/release-notes/2024-10-release-notes-data-science.md) - [2024-09: Slack Huddles, MSFT Teams, & Custom Group Naming](https://docs.worklytics.co/knowledge-base/release-notes/2024-09-release-notes-slack-huddles.md) - [2024-09: Calendar 3.0](https://docs.worklytics.co/knowledge-base/release-notes/2024-09-release-notes-calendar-3.0.md) - [2024-08: Fragmented & Interrupted Time](https://docs.worklytics.co/knowledge-base/release-notes/2024-08-release-notes-fragmented.md) - [2024-07: Manager & Sales Metrics](https://docs.worklytics.co/knowledge-base/release-notes/2024-07-release-notes-manager.md) - [2024-06: Intensity & After-Hours Chat](https://docs.worklytics.co/knowledge-base/release-notes/2024-06-release-notes-intensity.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.worklytics.co/knowledge-base/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.