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

# Issue

Issues represent work items in your issue tracker (such as Jira, Linear, etc.).

## Properties

### ID

`id` - [uuid](/data-model/types/uuid.md)

ID of the issue.

### Data source

`dataSource` - [IssueDataSource](/data-model/types/enum/issuedatasource.md)

Data source of the issue (such as Jira, Linear, etc.).

### Source URL

`sourceUrl` - [url](/data-model/types/url.md)

URL of the issue in the issue tracker.

### Source ID

`sourceId` - [text](/data-model/types/text.md)

ID of the issue in the issue tracker.

### Issue type

`issueType` - [text](/data-model/types/text.md) | null

Swarmia issue type of the issue.

### Source issue type

`sourceIssueType` - [text](/data-model/types/text.md)

Issue type in the issue tracker.

### Source issue type icon URL

`sourceIssueTypeIconUrl` - [url](/data-model/types/url.md) | null

Swarmia-served URL for the issue type’s icon. Null when no icon is available.

### Source issue status

`sourceIssueStatus` - [text](/data-model/types/text.md) | null

Status in the issue tracker.

### Priority

`priorityLabel` - [text](/data-model/types/text.md) | null

Priority of the issue as reported by the issue tracker (such as Medium, High, etc.).

### Issue key

`issueKey` - [text](/data-model/types/text.md)

Key of the issue in the issue tracker.

### Title

`title` - [text](/data-model/types/text.md)

Title of the issue.

### Description

`description` - [text](/data-model/types/text.md) | null

Description of the issue from the issue tracker, in Markdown format.

### Issue status

`status` - [IssueStatus](/data-model/types/enum/issuestatus.md) | null

Status of the issue as normalized by Swarmia (such as To do, Done, etc.).

### Started at

`startedAt` - [timestamp](/data-model/types/timestamp.md) | null

Time the issue’s status was first set to In Progress.

### Completed at

`completedAt` - [timestamp](/data-model/types/timestamp.md) | null

Time the issue was completed.

### Final status at

`finalStatusAt` - [timestamp](/data-model/types/timestamp.md) | null

Time the issue’s status was last changed.

### Source created at

`createdAt` - [timestamp](/data-model/types/timestamp.md)

Time the issue was created in the issue tracker.

### Source updated at

`updatedAt` - [timestamp](/data-model/types/timestamp.md)

Time the issue was last updated in the issue tracker.

### Cycle time

`totalCycleTime` - [timestampMultirange](/data-model/types/timestampmultirange.md) | null

Total cycle time of the issue. Not defined if the issue is not completed.

### In progress

`inProgressTime` - [timestampMultirange](/data-model/types/timestampmultirange.md) | null

Time the issue has been in progress.

### Scope increase

`scopeIncrease` - [double](/data-model/types/double.md) | null

Ratio of direct children created after the issue started (scope creep) to those created before its start. Null when the issue has no start or no initial children (the ratio is undefined). Excludes Won’t do children.

### Is leaf issue

`isLeafIssue` - [boolean](/data-model/types/boolean.md)

Whether the issue is a leaf (has no child issues).

### Labels

`labels` - [Array](/data-model/types/array.md)<[text](/data-model/types/text.md)>

Any labels assigned to the issue.

### Timestamp

`timestamp` - [timestamp](/data-model/types/timestamp.md)

Latest time the issue was in progress, falling back to creation time.

### Estimate

`estimate` - [double](/data-model/types/double.md) | null

Estimation value for the issue, e.g. story point from Jira or estimate from Linear.

### Flow efficiency

`flowEfficiency` - [percentage](/data-model/types/percentage.md)

Share of days with work item activity out of the business days in the issue’s activity window, including weekend days that had activity. Between 0 and 100.

## Relations

### Historical assignees

`historicalAssignees` - [Author](/data-model/entities/author.md) (1-N)

Authors who have ever been assigned to the issue.

### Assignee

`assignee` - [Author](/data-model/entities/author.md) (1-1)

Author assigned to the issue.

### Parent issue

`parentIssue` - [Issue](/data-model/entities/issue.md) (1-1)

Direct parent in the issue hierarchy. Null for issues with no parent.

### Children

`children` - [Issue](/data-model/entities/issue.md) (1-N)

Issues whose parent is this issue (single hop, no further descendants).

### Owner teams

`ownerTeams` - [Team](/data-model/entities/team.md) (1-N)

Teams owning this issue.

### Ancestor issues

`ancestorIssues` - [Issue](/data-model/entities/issue.md) (1-N)

All ancestor issues up the parent chain.

### All linked pull requests

`allLinkedPullRequests` - [Pull request](/data-model/entities/pull-request.md) (1-N)

Pull requests linked to this issue or any of its descendant issues.

### Linked pull requests

`linkedPullRequests` - [Pull request](/data-model/entities/pull-request.md) (1-N)

Pull requests linked to this issue.

## Aggregates

### In progress, avg.

`averageWorkInProgress` - [double](/data-model/types/double.md) | null

Average amount of issues in progress over a period of time.

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