> For the complete documentation index, see [llms.txt](https://help.swarmia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.swarmia.com/data-model/entities/index.md).

# All entities

Every entity in the data model, in alphabetical order.

* [AI assistant usage weekly snapshot](/data-model/entities/ai-tools/author-ai-assistant-weekly-snapshot.md) — Weekly AI assistant access and usage per author and tool.
* [AI daily cost](/data-model/entities/ai-tools/ai-daily-cost.md) — Daily AI tool cost per author.
* [AI service](/data-model/entities/ai-tools/ai-service.md) — AI tool integrations and attribution availability.
* [Annotation](/data-model/entities/other/annotation.md) — Annotations represent user-created notes attached to other entities.
* [Author](/data-model/entities/organization/author.md) — Authors are the people or bots that can be attributed different kinds of work items (commits, pull requests, reviews). Authors can be linked to multiple identities across different systems (GitHub, Slack, Jira, etc.).
* [Author attribute](/data-model/entities/organization/author-attribute.md) ([Beta](/data-model/entities/stability-levels/beta.md)) — Attribute that can be set on authors, such as Job title or City.
* [Author attribute value](/data-model/entities/organization/author-attribute-value.md) ([Beta](/data-model/entities/stability-levels/beta.md)) — One distinct value in use for an attribute, such as New York for City or Engineer for Job title.
* [CI check run](/data-model/entities/deployments-and-ci/ci-check-run.md) — Completed checks linked to a CI workflow run, including workflow job runtimes.
* [CI workflow](/data-model/entities/deployments-and-ci/ci-workflow.md) — CI pipeline definition, such as a workflow file.
* [CI workflow run](/data-model/entities/deployments-and-ci/ci-workflow-run.md) — Completed run of a CI workflow.
* [Claude Code daily metrics](/data-model/entities/ai-tools/claude-code-metrics-daily-snapshot.md) ([Deprecated](/data-model/entities/stability-levels/deprecated.md)) — Daily Claude Code usage per author.
* [Code source installation](/data-model/entities/code/code-source-installation.md) — Installations of code hosting providers like GitHub, GitLab, etc.
* [Commit](/data-model/entities/code/commit.md) — Commits represent individual git commits in your code repositories.
* [Cursor daily metrics](/data-model/entities/ai-tools/cursor-metrics-daily-snapshot.md) ([Deprecated](/data-model/entities/stability-levels/deprecated.md)) — Daily Cursor usage per author.
* [Daily effort](/data-model/entities/investment-and-effort/effort-daily.md) — Swarmia’s estimate of the effort spent per author per day towards specific work items.
* [Daily effort total](/data-model/entities/investment-and-effort/effort-daily-total.md) — Swarmia’s estimate of how much of a full-time equivalent an author accounted for on a single day. One row per author per day. Use `EffortDaily` when you need that day broken down by issue or pull request.
* [Data sync webhook record](/data-model/entities/data-sync/data-sync-webhook-record.md) — Per-installation, per-resource record tracking the most recent webhook received and its outcome.
* [Deployment](/data-model/entities/deployments-and-ci/deployment.md) — Code deployed to an environment, the core item for computing DORA metrics.
* [Deployment application](/data-model/entities/deployments-and-ci/deployment-application.md) — Deployment application is a configuration for ingesting deployments from a specific source.
* [Enrichment](/data-model/entities/other/enrichment.md) ([Beta](/data-model/entities/stability-levels/beta.md)) — A value extracted from a pull request or issue by an enrichment rule, such as the review effort CodeRabbit estimates for a pull request.
* [GitHub Copilot daily metrics](/data-model/entities/ai-tools/github-copilot-user-metrics-daily-snapshot.md) — Daily GitHub Copilot usage per author.
* [GitHub Copilot daily metrics by IDE](/data-model/entities/ai-tools/github-copilot-user-ide-metrics-daily-snapshot.md) ([Deprecated](/data-model/entities/stability-levels/deprecated.md)) — Daily GitHub Copilot usage per author and IDE. Is active applies to the author’s whole day, not just this IDE.
* [GitHub team](/data-model/entities/organization/github-team.md) — Team synced from your GitHub organization.
* [Incident](/data-model/entities/incidents/incident.md) ([Beta](/data-model/entities/stability-levels/beta.md)) — Operational incidents synced from incident management tools (PagerDuty or incident.io).
* [Incident service](/data-model/entities/incidents/incident-service.md) ([Beta](/data-model/entities/stability-levels/beta.md)) — Services tracked in incident management tools (such as APIs, databases, etc.).
* [Incident source](/data-model/entities/incidents/incident-source-installation.md) ([Beta](/data-model/entities/stability-levels/beta.md)) — Incident management accounts connected to Swarmia.
* [Initiative](/data-model/entities/issues/initiative.md) — Initiatives are high-level goals that group related issues together. They can be managed in Swarmia, or synced from issue trackers like Jira or Linear.
* [Investment breakdown](/data-model/entities/investment-and-effort/investment-breakdown.md) — Investment breakdown consists of multiple investment categories. Work is attributed to each category based on issue and pull request filters.
* [Investment category](/data-model/entities/investment-and-effort/investment-category.md) — Issues and pull requests are categorized into different investment categories based on a set of ordered rules.
* [Investment category assignment](/data-model/entities/investment-and-effort/investment-category-assignment.md) — Assignment of an investment category to an issue or pull request.
* [Issue](/data-model/entities/issues/issue.md) — Issues represent work items in your issue tracker (such as Jira, Linear, etc.).
* [Issue custom field](/data-model/entities/issues/issue-custom-field.md) — Definition for the custom field.
* [Issue custom field value](/data-model/entities/issues/issue-custom-field-value.md) — Value of a custom field for an issue.
* [Issue source installation](/data-model/entities/issues/issue-source-installation.md) — Issue tracker instances used by the organization (such as Jira, Linear, etc.).
* [Issue sprint period](/data-model/entities/issues/issue-sprint-period.md) — Represents an issue that was part of a sprint.
* [Issue status period](/data-model/entities/issues/issue-status-period.md) — Represents the time periods an issue has spent in a specific status.
* [Issue status transition](/data-model/entities/issues/issue-status-transition.md) — One row per issue and ordered pair of source statuses the issue moved between directly. Jira only, as Swarmia builds status periods from the Jira status changelog.
* [Issue time in status](/data-model/entities/issues/issue-time-in-status.md) — One row per issue and source status, rolling up every separate visit the issue made to that status. Jira only, as Swarmia builds status periods from the Jira status changelog.
* [Jira issue link](/data-model/entities/issues/jira-issue-link.md) — Directed link between two Jira issues — e.g. "blocks", "duplicates", or "belongs to". It reads as a sentence: "{outward issue} {outward phrase} {inward issue}", e.g. "PROJ-1 blocks PROJ-2".
* [Monthly capitalization](/data-model/entities/investment-and-effort/capex-monthly.md) — Immutable software-capitalization snapshot: one row per author and issue per month, captured at generation time so the numbers stay auditable even as the live data changes.
* [Monthly effort](/data-model/entities/investment-and-effort/effort-monthly.md) — Swarmia’s estimate of the effort spent per author per month towards specific issues and pull requests.
* [Organization](/data-model/entities/organization/organization.md) — Swarmia organization.
* [Organization cost settings](/data-model/entities/investment-and-effort/organization-cost-settings.md) — Cost settings configured for an organization, used to estimate the monetary cost of engineering effort. Only readable by users who can view engineering cost; empty otherwise.
* [Project](/data-model/entities/issues/project.md) — Projects from issue trackers like Jira, Linear, etc.
* [Pull request](/data-model/entities/code/pull-request.md) — Proposed code change in one of your repositories: a pull request in GitHub, or a merge request in GitLab.
* [Pull request agent review](/data-model/entities/ai-tools/pull-request-agent-review.md) — Record of a pull request agent review. Can be derived from a formal review in source data, or synthesized from other evidence that the agent looked through the PR.
* [Pull request AI attribution category](/data-model/entities/ai-tools/pull-request-ai-attribution-category.md) ([Deprecated](/data-model/entities/stability-levels/deprecated.md)) — Categories for pull requests based on AI tool usage.
* [Pull request comment](/data-model/entities/code/pull-request-comment.md) — Comment related to a pull request review flow, including top-level comments, inline review comments, and review body text.
* [Pull request deployment](/data-model/entities/deployments-and-ci/pull-request-deployment.md) — Pull Request Deployments track when individual pull requests are deployed to an environment.
* [Pull request review](/data-model/entities/code/pull-request-review.md) — Review submission on a pull request, such as an approval, request for changes, or general comment.
* [Pull request review request](/data-model/entities/code/pull-request-review-request.md) — Request for a review on a pull request, targeting either a specific author or a team.
* [Repository](/data-model/entities/code/repository.md) — Repositories represent your code repositories (GitHub, GitLab, etc.).
* [Role assignment](/data-model/entities/organization/user-role-assignment.md) — Role given to a Swarmia user, either organization-wide or for a specific team.
* [Signal episode](/data-model/entities/agreements-and-signals/signal-episode.md) — Signal episode scoped to an organization and optionally a team. Open while its triggering condition holds and closed when the condition no longer applies.
* [Sprint](/data-model/entities/issues/sprint.md) — Sprints represent time-boxed iterations in your issue tracker (Jira, Linear, etc.).
* [Survey](/data-model/entities/surveys/survey.md) — Swarmia survey sent to teams.
* [Survey comment](/data-model/entities/surveys/survey-comment.md) — Comment on a survey question.
* [Survey question](/data-model/entities/surveys/survey-question.md) — Question in a Swarmia survey.
* [Survey question answer](/data-model/entities/surveys/survey-question-answer.md) — Answer to a question in a Swarmia survey.
* [Team](/data-model/entities/organization/team.md) — Teams represent your organization structure and are the owners of other entities like issues and pull requests.
* [Team membership](/data-model/entities/organization/team-membership.md) — Team memberships represent the periods when authors belong to teams, including inherited memberships through the team hierarchy.
* [User](/data-model/entities/organization/user.md) — Swarmia user account.

{% hint style="info" %}
This page is automatically generated
{% endhint %}


---

# 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
If you need additional information that is not directly available in this page, you can query the documentation 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/data-model/entities/index.md?ask=<question>&goal=<user_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.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.