> 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.md).

# Entities

These are the common data models Swarmia uses to normalize and abstract over your data set. You can interact with these models through various facets of Swarmia, such as the built-in reports in the app, your custom reports, the [Swarmia APIs](/settings/integrations/swarmia-apis.md), Swarmia AI and the MCP server.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Code</strong></td><td>Pull requests, their reviews and comments, commits, and the repositories they belong to.</td><td><a href="/data-model/entities/code.md">Code</a></td></tr><tr><td><strong>Issues</strong></td><td>Issues from your issue trackers, and the projects, sprints, and initiatives that organize them.</td><td><a href="/data-model/entities/issues.md">Issues</a></td></tr><tr><td><strong>Deployments &#x26; CI</strong></td><td>Deployments, the pull requests each one shipped, and CI workflows with their runs and check runs.</td><td><a href="/data-model/entities/deployments-and-ci.md">Deployments &amp; CI</a></td></tr><tr><td><strong>AI tools</strong></td><td>AI tool usage, costs and adoption, and how AI contributes to pull requests and reviews.</td><td><a href="/data-model/entities/ai-tools.md">AI tools</a></td></tr><tr><td><strong>Organization</strong></td><td>Your organization, its users, teams, and the authors who contribute work.</td><td><a href="/data-model/entities/organization.md">Organization</a></td></tr><tr><td><strong>Investment &#x26; effort</strong></td><td>Effort estimates, investment categories, software capitalization, and the cost settings used to put a price on engineering work.</td><td><a href="/data-model/entities/investment-and-effort.md">Investment &amp; effort</a></td></tr><tr><td><strong>Incidents</strong> (Beta)</td><td>Incidents, the services they affect, and the incident management tools they come from.</td><td><a href="/data-model/entities/incidents.md">Incidents</a></td></tr><tr><td><strong>Surveys</strong></td><td>Surveys sent to teams, their questions, and the answers and comments they collect.</td><td><a href="/data-model/entities/surveys.md">Surveys</a></td></tr><tr><td><strong>Agreements &#x26; signals</strong></td><td>Working agreements teams set for themselves, and the signals that flag when something needs attention.</td><td><a href="/data-model/entities/agreements-and-signals.md">Agreements &amp; signals</a></td></tr><tr><td><strong>Data sync</strong></td><td>Records of the data Swarmia receives from your integrations.</td><td><a href="/data-model/entities/data-sync.md">Data sync</a></td></tr><tr><td><strong>Other</strong></td><td>Entities that attach to several kinds of other entities.</td><td><a href="/data-model/entities/other.md">Other</a></td></tr><tr><td><strong>All entities</strong></td><td>Every entity in one alphabetical list.</td><td><a href="/data-model/entities/index.md">All entities</a></td></tr></tbody></table>

Entities, properties, relations and aggregates may be labeled Beta or Deprecated: see [Stability levels](/data-model/entities/stability-levels.md).

## Relations

Each relation says how many related entities it points to:

* **one**: exactly one related entity.
* **zero or one**: at most one related entity, or `null` when there is none.
* **many**: a list of related entities, which can be empty.

{% 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.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.