# Swarmia docs ## Swarmia Documentation - [Swarmia documentation](https://help.swarmia.com/readme.md) - [Get started in 15 minutes](https://help.swarmia.com/getting-started/get-started-in-15-minutes.md): Connect your code hosting platform, issue tracker, AI tools, messaging app, and create Swarmia teams to get started. - [Focus](https://help.swarmia.com/features/focus.md) - [Focus summary](https://help.swarmia.com/features/focus/focus-summary.md): The focus summary allows you to easily explore what your teams and organization are spending the most effort (FTEs) on. - [Investment balance](https://help.swarmia.com/features/focus/balance-engineering-investments.md): Analyze team focus, improve time allocation and boost focus on top priorities - [Activity and effort-based models](https://help.swarmia.com/features/focus/balance-engineering-investments/activity-and-effort-based-models.md): Swarmia supports two different models to measure the work: activity-based and effort-based - [Categorization](https://help.swarmia.com/features/focus/balance-engineering-investments/categorizing-work.md): Configure custom categories and and improve the categorization rate. - [Initiatives](https://help.swarmia.com/features/focus/deliver-strategic-initiatives.md): Set up your initiatives to enable visibility beyond team-level work. - [Work log](https://help.swarmia.com/features/focus/analyzing-the-activity-patterns-on-work-log.md): Work log visualizes the various activities of your team. Knowing which work patterns to avoid and which to aim for helps teams improve their health and development speed. - [Sprints](https://help.swarmia.com/features/focus/sprints.md): Swarmia tracks the issues linked to your sprints and helps you visualize scope increase and carryover. - [Metrics](https://help.swarmia.com/features/metrics.md) - [Code metrics](https://help.swarmia.com/features/metrics/code-metrics.md) - [Codebase](https://help.swarmia.com/features/metrics/code-metrics/codebase.md): See which parts of your codebase change the most - [PR cycle time](https://help.swarmia.com/features/metrics/pull-request-cycle-time.md): Pull request cycle time (or PR cycle time) is the total time a pull request spends in all stages of the development pipeline. - [Time to review](https://help.swarmia.com/features/metrics/pull-request-cycle-time/time-to-review.md): Learn how Swarmia calculates pull request review metrics, including time to first review and review time. - [What's the difference between "Change lead time" and "Pull request cycle time" metrics in Swarmia?](https://help.swarmia.com/features/metrics/pull-request-cycle-time/whats-the-difference-between-change-lead-time-and-pull-request-cycle-time-metrics-in-swarmia.md) - [DORA metrics](https://help.swarmia.com/features/metrics/track-dora-metrics.md): Analyze deployment frequency and quality across your entire organization in Swarmia. - [Automatic change failure detection](https://help.swarmia.com/features/metrics/track-dora-metrics/automatic-change-failure-detection.md): Automatically detect DORA change failures from application version rollback, pull request reverts, and advanced hotfix filters. - [How Swarmia links PRs to deployments](https://help.swarmia.com/features/metrics/track-dora-metrics/how-swarmia-links-prs-to-deployments.md): Linked PRs are used to calculate change lead time and time to deploy. The are also used to determine who owns the deployment. - [Issue metrics](https://help.swarmia.com/features/metrics/issue-cycle-time.md): Issue metrics help you understand how your engineering teams are delivering work — how fast issues move through your process, how much work is in progress, and how throughput changes over time. - [CI visibility](https://help.swarmia.com/features/metrics/get-visibility-into-your-ci-pipeline.md): Swarmia provides you with the most important CI metrics for tracking your CI health - [Explore](https://help.swarmia.com/features/metrics/explore.md) - [Key metrics](https://help.swarmia.com/features/metrics/key-metrics.md): Key metrics let you pin your most important engineering indicators to the Swarmia front page, so everyone in your organization sees the same shared view of performance every time they log in. - [AI tools](https://help.swarmia.com/features/ai-tools.md): Track AI coding tool adoption, activity, impact, and agent usage in Swarmia. - [AI adoption](https://help.swarmia.com/features/ai-tools/ai-adoption.md): Track GitHub Copilot, Cursor, Claude Code, and Codex licenses and adoption across your teams over time - [AI readiness](https://help.swarmia.com/features/ai-tools/ai-readiness.md): See whether your repositories give AI agents the context and delivery pipeline they need to ship reliable work - [GitHub Copilot activity](https://help.swarmia.com/features/ai-tools/github-copilot-activity.md): See detailed GitHub Copilot activity patterns across teams, features, models, editors, and programming languages - [Cursor activity](https://help.swarmia.com/features/ai-tools/cursor-activity.md): See detailed Cursor activity patterns across teams and modes - [Claude Code activity](https://help.swarmia.com/features/ai-tools/claude-code-activity.md): See detailed Claude Code activity patterns across teams and modes - [AI impact: Code](https://help.swarmia.com/features/ai-tools/ai-impact-code.md): See how pull requests assisted by different AI coding tools — or no AI tools — perform across metrics like throughput, cycle time, batch size, and review time. - [AI impact: ROI](https://help.swarmia.com/features/ai-tools/ai-impact-roi.md): Compare the combined cost of your AI tools and engineering work against the stories, pull requests, and code your teams deliver. - [AI cost](https://help.swarmia.com/features/ai-tools/ai-cost.md): Track the AI token usage of your organization’s AI coding tools, and see how it maps to teams, people, and work - [Cloud agents](https://help.swarmia.com/features/ai-tools/cloud-agents.md): Gain visibility into the pull requests created by AI agents running in the cloud. See how they perform across metrics like throughput, merge percentage, and batch size. - [Review agents](https://help.swarmia.com/features/ai-tools/review-agents.md): See which AI agents are reviewing your pull requests, how much of your code they're covering, and how many findings they're leaving per PR. - [AI tool detection & filters](https://help.swarmia.com/features/ai-tools/ai-tool-detection-and-filters.md): Swarmia automatically detects pull requests assisted by AI tools you've connected - [Signals](https://help.swarmia.com/features/signals.md) - [PR inbox](https://help.swarmia.com/features/managing-pull-requests-in-progress-with-the-pull-request-view.md): See all open pull requests and where they are going in a team context. - [Working agreements](https://help.swarmia.com/features/working-agreements.md): Working agreements help teams continuously improve with clear goals and consistent execution - [Surveys](https://help.swarmia.com/features/run-developer-experience-surveys.md): See what truly affects developer experience and productivity by viewing relevant survey results alongside your system data. - [Creating a survey](https://help.swarmia.com/features/run-developer-experience-surveys/creating-a-survey.md): Improve developer experience by collecting insights directly from your engineers at scale. Identify patterns and turn them into actions. - [Managing surveys](https://help.swarmia.com/features/run-developer-experience-surveys/managing-surveys.md): You can create, preview, duplicate, close, and delete surveys. - [Viewing and sharing survey results](https://help.swarmia.com/features/run-developer-experience-surveys/viewing-and-sharing-survey-results.md): After a survey ends, you can review the results, publish them to your teams, or export them - [How we show your survey responses](https://help.swarmia.com/features/run-developer-experience-surveys/how-we-show-your-survey-responses.md): Responses are reported by team. You can choose whether to show your name in comments. - [Survey communication guide and templates](https://help.swarmia.com/features/run-developer-experience-surveys/survey-communication-guide-and-templates.md): You can use this messaging sequence and templates to communicate your developer experience survey to your teams. - [Software capitalization](https://help.swarmia.com/features/capitalize-software-development-costs.md): Use developer activity data from Swarmia to generate capitalization reports and blend with cost data. - [Timesheets](https://help.swarmia.com/features/capitalize-software-development-costs/timesheets.md): Timesheets help your organization record, approve, and export hours at the daily and individual level without manual tracking during work. - [Swarmia AI](https://help.swarmia.com/features/swarmia-ai.md): Ask questions about engineering data and turn answers into charts and reports. - [Developer overview](https://help.swarmia.com/features/coach-software-developers.md): Visualize engineering work with Developer Overview - [Notes](https://help.swarmia.com/features/notes.md): You can attach freeform context information to work items like pull requests and issues with notes. - [Forecast](https://help.swarmia.com/features/forecast.md): Predict when work will finish and how much effort is left, using a Monte Carlo simulation of your team's past effort. - [Identify and improve delivery bottlenecks](https://help.swarmia.com/guides/identify-and-improve-delivery-bottlenecks.md) - [Understand how engineering time is spent](https://help.swarmia.com/guides/understand-how-engineering-time-is-spent.md) - [Improve pull request flow](https://help.swarmia.com/guides/improve-pull-request-flow.md): Get visibility into your team’s pull requests and the contributing factors behind cycle time: the number of pull requests in progress, batch size, and review time. - [Pull request insights](https://help.swarmia.com/guides/improve-pull-request-flow/pull-request-insights.md): Diagnose cycle time issues, decrease review time and improve pull request workflow with Swarmia's pull request insights. - [Reducing pull request cycle time](https://help.swarmia.com/guides/improve-pull-request-flow/reducing-pull-request-cycle-time.md): Get pull requests through faster with Swarmia's insights and working agreements around cycle time. - [Review code faster](https://help.swarmia.com/guides/improve-pull-request-flow/review-code-faster.md): Code rarely ages well, and merging doesn’t get any easier over time. Here's how Swarmia helps your team get pull requests through faster. - [Diagnosing low pull request throughput](https://help.swarmia.com/guides/improve-pull-request-flow/diagnosing-low-pull-request-throughput.md): Throughput is more difficult to improve than for example cycle time, since it reflects the team's overall situation rather than just the process. - [Analyzing pull request batch size](https://help.swarmia.com/guides/improve-pull-request-flow/analyzing-pull-request-batch-size.md): Batch size measures how much work is bundled up in a change. Swarmia offers tools for evaluating pull request batch size by looking at the total amount of changes. - [Improve code quality](https://help.swarmia.com/guides/improve-code-quality.md): Build better quality products, reduce technical debt, and implement development practices that scale as your team grows - [Improve your team's focus](https://help.swarmia.com/guides/improve-your-teams-focus.md) - [Optimizing issue cycle time](https://help.swarmia.com/guides/improve-your-teams-focus/optimizing-issue-cycle-time.md): Practical tips and best practices for improving your focus and structuring work to reduce issue cycle times. - [Benchmarks & comparisons](https://help.swarmia.com/guides/benchmarks-and-comparisons.md): Compare your engineering metrics to Swarmia benchmarks, and analyze how different teams compare against your organization's average. - [Retrospectives with Swarmia](https://help.swarmia.com/guides/retrospective-guide.md): How to run great retrospectives with Swarmia. - [Improve developer experience](https://help.swarmia.com/guides/improve-developer-experience.md): Spot what's slowing your engineers down — flaky CI, slow feedback loops, unclear priorities, or tooling pain — and fix it. - [Understand the impact of AI tools](https://help.swarmia.com/guides/understand-the-impact-of-ai-tools.md): Combine developer experience surveys, adoption metrics, and usage patterns to understand how AI coding tools play into your software organization's productivity. - [Use Swarmia in meetings and team rituals](https://help.swarmia.com/guides/use-swarmia-in-meetings-and-team-rituals.md) - [Drive continuous improvement](https://help.swarmia.com/guides/drive-continuous-improvement.md): Learn how to use surveys, signals, and working agreements to build a continuous improvement practice your team can own. - [Developer effort (FTEs)](https://help.swarmia.com/definitions/developer-effort-ftes.md): Learn how developer effort is measured in Swarmia - [What changed in the effort model in August 2026](https://help.swarmia.com/definitions/developer-effort-ftes/daily-effort-model.md): Developer effort is now calculated daily instead of monthly. - [DORA & deployment metrics](https://help.swarmia.com/definitions/dora-metrics.md) - [Change lead time](https://help.swarmia.com/definitions/dora-metrics/change-lead-time.md): Change lead time measures the full lifecycle of a pull request from the first commit to deployment. - [Time to deploy](https://help.swarmia.com/definitions/dora-metrics/time-to-deploy.md): Time to deploy is the average time between a pull request merge and deployment. - [Deployment frequency](https://help.swarmia.com/definitions/dora-metrics/deployment-frequency.md): Deployment frequency is calculated by looking at the total number of deployments that happened in a given time period. - [Mean time to recovery](https://help.swarmia.com/definitions/dora-metrics/mean-time-to-recovery.md): Mean time to recovery represents the average time between a failing deployment and a deployment that is marked as a fix. - [Change failure rate](https://help.swarmia.com/definitions/dora-metrics/change-failure-rate.md): Change failure rate is the ratio of failed deployments to all deployments. - [Throughput](https://help.swarmia.com/definitions/throughput.md): Throughput is defined as the number of pull requests you get through as a team over a selected period of time. - [Normalized throughput](https://help.swarmia.com/definitions/throughput/normalized-throughput.md): Normalizing issue or pull request throughput by active full-time equivalent developers helps make teams and time periods more comparable. - [Batch size](https://help.swarmia.com/definitions/batch-size.md): Batch size measures how much work is bundled up in a change. Swarmia offers tools for evaluating pull request batch size by looking at the total number of changes in a single pull request. - [Issue cycle time](https://help.swarmia.com/definitions/defining-issue-lifecycle-and-cycle-time.md): Issues progress through various stages of completeness during their lifetime. Swarmia automatically calculates key properties and metrics for each issue. - [Flow efficiency](https://help.swarmia.com/definitions/flow-efficiency.md): The flow efficiency of an issue is the percentage of days when the issue was actively worked on compared to its whole lifetime. - [Scope creep](https://help.swarmia.com/definitions/scope-creep.md): Scope creep measures the amount of work added to an issue while it was in progress. - [Definitions FAQ](https://help.swarmia.com/definitions/frequently-asked-questions.md) - [How do you treat weekends in metrics?](https://help.swarmia.com/definitions/frequently-asked-questions/how-do-you-treat-weekends-in-metrics.md) - [Tracking squashed commits](https://help.swarmia.com/definitions/frequently-asked-questions/tracking-squashed-commits.md): GitHub allows you to "squash" commits before merging a pull request. Swarmia supports this workflow. - [How do merge queues affect my metrics?](https://help.swarmia.com/definitions/frequently-asked-questions/how-do-merge-queues-affect-my-metrics.md): GitHub supports merging pull requests using a merge queue. This doesn't affect the definitions of cycle time or DORA metrics. - [Why is my commit not visible in Swarmia?](https://help.swarmia.com/definitions/frequently-asked-questions/why-is-my-commit-not-visible-in-swarmia.md): We include only commits from pull requests. Check that the pull request is visible in Swarmia. - [What happens when people switch teams or leave?](https://help.swarmia.com/definitions/frequently-asked-questions/how-do-i-account-for-people-leaving-my-organization.md): Swarmia tracks the historical team memberships of contributors over time. Contributions made for one team will stay correctly attributed, even if their author later switches teams or leaves. - [How do I configure Swarmia if I use the Gitflow branching strategy?](https://help.swarmia.com/definitions/frequently-asked-questions/how-do-i-configure-swarmia-if-i-use-the-gitflow-branching-strategy.md) - [Settings overview](https://help.swarmia.com/settings/configuration.md): The article provides an overview of settings to ensure your data is accurate in Swarmia and links you to further reading and the related settings in the Swramia app. - [Team settings](https://help.swarmia.com/settings/configuration/team-setup.md): Configure Swarmia and get up and running with your team - [Team](https://help.swarmia.com/settings/team.md) - [Team PR exclusions](https://help.swarmia.com/settings/team/team-pr-exclusions.md) - [Issue ownership](https://help.swarmia.com/settings/team/issue-ownership.md) - [Team notifications](https://help.swarmia.com/settings/team/team-notifications.md) - [Sprint configuration](https://help.swarmia.com/settings/team/sprints.md): To view Jira data in Swarmia, you must first assign the appropriate Jira board to your team. - [Organization](https://help.swarmia.com/settings/organization.md) - [Creating & managing teams](https://help.swarmia.com/settings/organization/managing-teams.md) - [CSV team import](https://help.swarmia.com/settings/organization/managing-teams/csv-team-import.md) - [Authors](https://help.swarmia.com/settings/organization/contributors.md) - [Roles and permissions](https://help.swarmia.com/settings/organization/managing-users-and-roles.md): Overview of Swarmia access control. - [Inviting team members](https://help.swarmia.com/settings/organization/inviting-team-members.md): Invite members with by sharing a link or via Slack. - [Investment categories](https://help.swarmia.com/settings/organization/investment-balance.md): Everything you need to know about setting up your Investment Balance and configuring your organization's categories. - [Automatic categorization](https://help.swarmia.com/settings/organization/investment-balance/automatic-categorization.md): Automatic investment balance categorization works to catch issues that slip your rules or to categorize entire breakdowns without rules. - [Deployments](https://help.swarmia.com/settings/organization/configuring-deployments-in-swarmia.md): Set up deployments by creating an application and selecting your source. - [Generate deployments from merged pull requests](https://help.swarmia.com/settings/organization/configuring-deployments-in-swarmia/generate-deployments-from-merged-pull-requests.md): The simplest proxy for deployments is to assume a merged pull request is immediately deployed. - [Generate deployments from GitHub deployments](https://help.swarmia.com/settings/organization/configuring-deployments-in-swarmia/generate-deployments-from-github-deployments.md): If your release workflow already makes use of GitHub deployments, Swarmia can automatically track those deployments. - [Generate deployments from GitHub checks](https://help.swarmia.com/settings/organization/configuring-deployments-in-swarmia/generate-deployments-from-github-checks.md): Swarmia can generate deployments automatically from your CI/CD pipeline, using GitHub checks. - [Generate deployments via the API](https://help.swarmia.com/settings/organization/configuring-deployments-in-swarmia/generate-deployments-via-the-deployment-api.md): Deployment API gives you flexibility and a full control of deployment data, including tracking multiple environments. - [Generate deployments for monorepos via the API](https://help.swarmia.com/settings/organization/configuring-deployments-in-swarmia/generate-deployments-via-the-deployment-api/generate-deployments-for-monorepos.md): How to setup the Swarmia deployments API to track deployments from monorepos - [Pull requests](https://help.swarmia.com/settings/organization/pull-request-data-quality.md): Create filters to automatically exclude specific pull requests from all Swarmia metrics - [Issue linking](https://help.swarmia.com/settings/organization/pull-request-data-quality/linking-pull-requests-to-issues.md): Linking pull requests to issues allows you to group work by issues. This article describes the ways Swarmia can detect which issue a pull request is related to. - [Test file rules](https://help.swarmia.com/settings/organization/pull-request-data-quality/pull-request-test-file-rules.md): Classify changed files as code or test so you can track code and test changes separately in pull request metrics - [Integrations](https://help.swarmia.com/settings/integrations.md) - [Code hosting platforms](https://help.swarmia.com/settings/integrations/code-hosting-platforms.md): Sync version control activity an repository metadata to Swarmia. - [GitHub](https://help.swarmia.com/settings/integrations/code-hosting-platforms/github.md): Install the Swarmia GitHub app and sync GitHub activity an repository metadata to Swarmia. - [GitHub Enterprise Server & Enterprise Cloud with data residency](https://help.swarmia.com/settings/integrations/code-hosting-platforms/github/github-enterprise-server.md): Installation instructions for self-hosted GitHub Enterprise Server and Enterprise Cloud with data residency - [Multiple GitHub organizations](https://help.swarmia.com/settings/integrations/code-hosting-platforms/github/multiple-github-organizations.md): Swarmia supports connecting multiple GitHub organizations. - [Forked repositories](https://help.swarmia.com/settings/integrations/code-hosting-platforms/github/github-fork-repository-in-swarmia.md) - [Troubleshooting](https://help.swarmia.com/settings/integrations/code-hosting-platforms/github/troubleshooting.md) - [Reinstalling the Swarmia GitHub app](https://help.swarmia.com/settings/integrations/code-hosting-platforms/github/troubleshooting/reinstalling-the-swarmia-github-app.md): This article describes how to reinstall the Swarmia GitHub app from the GitHub Marketplace - [Updating app permissions](https://help.swarmia.com/settings/integrations/code-hosting-platforms/github/troubleshooting/github-permissions.md) - [Installing Swarmia outside of GitHub Marketplace](https://help.swarmia.com/settings/integrations/code-hosting-platforms/github/troubleshooting/github-app-without-marketplace.md): Installing the Swarmia GitHub app without GitHub Marketplace - [GitLab](https://help.swarmia.com/settings/integrations/code-hosting-platforms/gitlab.md): How to integrate your GitLab Server or GitLab Cloud instance to Swarmia and what permissions are required. - [Issue trackers](https://help.swarmia.com/settings/integrations/issue-trackers.md) - [Jira](https://help.swarmia.com/settings/integrations/issue-trackers/jira.md): Learn how to connect Jira to Swarmia. - [Jira configuration](https://help.swarmia.com/settings/integrations/issue-trackers/jira/jira-setup.md): Every organization uses Jira in a slightly different way. That's why we let you configure your Jira settings in a way that supports your teams current practices. - [Jira Server and Jira Data Center](https://help.swarmia.com/settings/integrations/issue-trackers/jira/jira-server-and-jira-data-center.md) - [Limiting Jira project access](https://help.swarmia.com/settings/integrations/issue-trackers/jira/limiting-jira-project-access.md): How to limit what projects Swarmia's Jira integration has access to. - [Best practices](https://help.swarmia.com/settings/integrations/issue-trackers/jira/jira-best-practices.md): While Swarmia adapts to any kind of Jira configuration, we wanted to share an example that's easy to set up. Our recommendation tries to strike a balance. This ensures data quality while also leaving - [Troubleshooting](https://help.swarmia.com/settings/integrations/issue-trackers/jira/troubleshooting.md): Troubleshooting common issues with the Jira integration. - [Linear](https://help.swarmia.com/settings/integrations/issue-trackers/linear.md): Learn how to connect your Linear organization to Swarmia. - [Linear configuration](https://help.swarmia.com/settings/integrations/issue-trackers/linear/linear-configuration.md) - [Private Linear teams](https://help.swarmia.com/settings/integrations/issue-trackers/linear/private-linear-teams.md): How to sync issue data for private teams in Linear to Swarmia - [Disconnect Linear](https://help.swarmia.com/settings/integrations/issue-trackers/linear/disconnect-linear.md) - [Azure Boards](https://help.swarmia.com/settings/integrations/issue-trackers/azure-boards.md): Learn how to connect your Azure DevOps (Azure Boards) organization to Swarmia using a Personal Access Token (PAT). - [Shortcut](https://help.swarmia.com/settings/integrations/issue-trackers/shortcut.md): Learn how to connect your Shortcut workspace to Swarmia with an API token. - [GitHub Issues](https://help.swarmia.com/settings/integrations/issue-trackers/github.md): Learn how to turn on GitHub Issues for a GitHub organization Swarmia already syncs code from. - [Messaging apps](https://help.swarmia.com/settings/integrations/messaging-apps.md) - [Slack](https://help.swarmia.com/settings/integrations/messaging-apps/slack.md): Learn how to connect your Slack organization to Swarmia. - [Private Slack channels](https://help.swarmia.com/settings/integrations/messaging-apps/slack/adding-swarmia-to-a-private-slack-channel.md) - [Microsoft Teams](https://help.swarmia.com/settings/integrations/messaging-apps/microsoft-teams.md): Learn how to connect your organization's Microsoft Teams to Swarmia. - [Adding Swarmia to a Microsoft Teams channel](https://help.swarmia.com/settings/integrations/messaging-apps/microsoft-teams/adding-swarmia-to-a-microsoft-teams-channel.md) - [Authentication](https://help.swarmia.com/settings/integrations/authentication.md): Swarmia supports authentication with GitHub, Google, Microsoft, and Okta. - [GitHub Authentication](https://help.swarmia.com/settings/integrations/authentication/github-authentication.md): Use GitHub authentication with your Swarmia organization - [Google Single Sign-On](https://help.swarmia.com/settings/integrations/authentication/google-single-sign-on.md): Use Google authentication with your Swarmia organization - [Frequently asked questions](https://help.swarmia.com/settings/integrations/authentication/google-single-sign-on/frequently-asked-questions.md) - [Microsoft Entra ID Single Sign-On](https://help.swarmia.com/settings/integrations/authentication/microsoft-entra-id-single-sign-on.md): Use Microsoft Entra ID authentication with your Swarmia organization - [Frequently asked questions](https://help.swarmia.com/settings/integrations/authentication/microsoft-entra-id-single-sign-on/frequently-asked-questions.md) - [Okta Single Sign-On](https://help.swarmia.com/settings/integrations/authentication/okta-single-sign-on.md): Instructions for enabling Okta Single Sign-On with Swarmia - [HR systems](https://help.swarmia.com/settings/integrations/hr-systems.md): Connect your HR system to sync time off into Swarmia. - [BambooHR](https://help.swarmia.com/settings/integrations/hr-systems/bamboohr.md): Connect Swarmia directly to BambooHR with OAuth to sync time off and match employees. - [HiBob](https://help.swarmia.com/settings/integrations/hr-systems/hibob.md): Connect Swarmia directly to HiBob with OAuth to sync time off and match employees. - [Personio](https://help.swarmia.com/settings/integrations/hr-systems/personio.md): Connect Swarmia directly to Personio with an API credential to sync time off and match employees. - [Workday](https://help.swarmia.com/settings/integrations/hr-systems/workday.md): Connect Swarmia directly to Workday to sync time off and leaves, and match workers. - [Upload time off data via CSV](https://help.swarmia.com/settings/integrations/hr-systems/upload-time-off-data-via-csv.md): Learn how to upload your time off periods to Swarmia using CSV files. - [Data export](https://help.swarmia.com/settings/integrations/data-export.md) - [Data cloud](https://help.swarmia.com/settings/integrations/data-export/data-cloud.md) - [Export data as a CSV file](https://help.swarmia.com/settings/integrations/data-export/export-data-as-a-csv-file.md) - [MCP server](https://help.swarmia.com/settings/integrations/mcp-server.md): How to connect Swarmia MCP to your AI client - [AI coding tool integrations](https://help.swarmia.com/settings/integrations/ai-coding-tool-integrations.md): Enabling GitHub Copilot, Cursor, Claude Code, Codex, and Custom AI tool metrics - [GitHub Copilot integration](https://help.swarmia.com/settings/integrations/ai-coding-tool-integrations/github-copilot-integration.md): Enabling GitHub Copilot metrics - [Cursor integration](https://help.swarmia.com/settings/integrations/ai-coding-tool-integrations/cursor-integration.md): Enabling Cursor metrics - [Claude Code integration](https://help.swarmia.com/settings/integrations/ai-coding-tool-integrations/claude-code-integration.md): Enabling Claude Code metrics with Analytics API or OpenTelemetry monitoring - [Send Claude Code OpenTelemetry metrics to multiple destinations](https://help.swarmia.com/settings/integrations/ai-coding-tool-integrations/claude-code-integration/claude-code-otel-collector.md): Send Claude Code OpenTelemetry metrics to Swarmia and another destination - [Codex integration](https://help.swarmia.com/settings/integrations/ai-coding-tool-integrations/codex-integration.md): Enabling Codex metrics - [Custom AI tool integrations](https://help.swarmia.com/settings/integrations/ai-coding-tool-integrations/custom-ai-tool-integrations.md): Link contributors or push usage data to track any custom AI coding tool in Swarmia. - [Connect Devin to Swarmia](https://help.swarmia.com/settings/integrations/ai-coding-tool-integrations/custom-ai-tool-integrations/connect-devin-to-swarmia.md): Swarmia detects Devin's pull requests, reviews, and commits automatically. Send Devin usage data to also see adoption and cost. - [Connect Amp Code to Swarmia](https://help.swarmia.com/settings/integrations/ai-coding-tool-integrations/custom-ai-tool-integrations/connect-amp-code-to-swarmia.md): Track Amp Code's Git activity and usage data in Swarmia. - [Proxy agent](https://help.swarmia.com/settings/integrations/proxy-agent.md) - [Swarmia APIs](https://help.swarmia.com/settings/integrations/swarmia-apis.md): Programmatic access to Swarmia data & features - [Built In Reports](https://help.swarmia.com/settings/integrations/swarmia-apis/built-in-reports.md) - [Custom Reports](https://help.swarmia.com/settings/integrations/swarmia-apis/custom-reports.md) - [Additional AI Integrations](https://help.swarmia.com/settings/integrations/swarmia-apis/additional-ai-integrations.md) - [Team management](https://help.swarmia.com/settings/integrations/swarmia-apis/team-management.md) - [Time offs](https://help.swarmia.com/settings/integrations/swarmia-apis/time-off-api.md) - [Export API v0](https://help.swarmia.com/settings/integrations/swarmia-apis/export-api.md): Swarmia provides an API for exporting data into e.g. spreadsheets or dashboards. - [Personal](https://help.swarmia.com/settings/personal.md) - [Personal notifications](https://help.swarmia.com/settings/personal/notifications.md) - [Entities](https://help.swarmia.com/data-model/entities.md) - [Author](https://help.swarmia.com/data-model/entities/author.md) - [Author attribute](https://help.swarmia.com/data-model/entities/author-attribute.md) - [Author attribute value](https://help.swarmia.com/data-model/entities/author-attribute-value.md) - [Issue](https://help.swarmia.com/data-model/entities/issue.md) - [Pull request](https://help.swarmia.com/data-model/entities/pull-request.md) - [Team](https://help.swarmia.com/data-model/entities/team.md) - [Team membership](https://help.swarmia.com/data-model/entities/team-membership.md) - [Types](https://help.swarmia.com/data-model/types.md) - [uuid](https://help.swarmia.com/data-model/types/uuid.md) - [text](https://help.swarmia.com/data-model/types/text.md) - [url](https://help.swarmia.com/data-model/types/url.md) - [timestamp](https://help.swarmia.com/data-model/types/timestamp.md) - [int](https://help.swarmia.com/data-model/types/int.md) - [double](https://help.swarmia.com/data-model/types/double.md) - [percentage](https://help.swarmia.com/data-model/types/percentage.md) - [timestampMultirange](https://help.swarmia.com/data-model/types/timestampmultirange.md) - [boolean](https://help.swarmia.com/data-model/types/boolean.md) - [json](https://help.swarmia.com/data-model/types/json.md) - [Enum](https://help.swarmia.com/data-model/types/enum.md) - [AuthorAttributeValueType](https://help.swarmia.com/data-model/types/enum/authorattributevaluetype.md) - [CodeDataSource](https://help.swarmia.com/data-model/types/enum/codedatasource.md) - [ExclusionSource](https://help.swarmia.com/data-model/types/enum/exclusionsource.md) - [IssueDataSource](https://help.swarmia.com/data-model/types/enum/issuedatasource.md) - [IssueLinkSource](https://help.swarmia.com/data-model/types/enum/issuelinksource.md) - [IssueStatus](https://help.swarmia.com/data-model/types/enum/issuestatus.md) - [ProcessStage](https://help.swarmia.com/data-model/types/enum/processstage.md) - [PullRequestStatus](https://help.swarmia.com/data-model/types/enum/pullrequeststatus.md) - [Entity](https://help.swarmia.com/data-model/types/entity.md) - [Array](https://help.swarmia.com/data-model/types/array.md) - [Security & data retention](https://help.swarmia.com/resources/security-and-data-retention.md) - [Data access](https://help.swarmia.com/resources/security-and-data-retention/data-access.md): What data does Swarmia access and why? - [Swarmia IP Addresses](https://help.swarmia.com/resources/security-and-data-retention/swarmia-ip-addresses.md): Our network topology and IP addresses - [Data residency](https://help.swarmia.com/resources/security-and-data-retention/data-residency.md): Where Swarmia stores your data - [Single Sign-On (SSO) / SAML](https://help.swarmia.com/resources/security-and-data-retention/single-sign-on-sso-saml.md): Many organizations use tools like Okta, Active Directory, or Google Workspace to manage users. Swarmia supports Single Sign-On through Okta, Microsoft Entra ID, Google and secure login through GitHub. - [Can I get a copy of the SOC 2 Type II audit report?](https://help.swarmia.com/resources/security-and-data-retention/can-i-get-a-copy-of-the-soc-2-type-ii-audit-report.md) - [Deleting your organization](https://help.swarmia.com/resources/security-and-data-retention/deleting-your-organization.md) - [Pricing & plans](https://help.swarmia.com/resources/pricing-and-plans.md): Pricing & plans FAQ. - [Getting help](https://help.swarmia.com/swarmia-support/getting-help.md): How to reach Swarmia support, what our AI agent Aimo does, and what you can contact us about. --- # 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://help.swarmia.com/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.