For the complete documentation index, see llms.txt. This page is also available as Markdown.

Issue

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

Properties

ID

id - uuid

ID of the issue.

Data source

dataSource - IssueDataSource

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

Source URL

sourceUrl - url

URL of the issue in the issue tracker.

Source ID

sourceId - text

ID of the issue in the issue tracker.

Issue type

issueType - text | null

Swarmia issue type of the issue.

Source issue type

sourceIssueType - text

Issue type in the issue tracker.

Source issue type icon URL

sourceIssueTypeIconUrl - url | null

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

Source issue status

sourceIssueStatus - text | null

Status in the issue tracker.

Priority

priorityLabel - text | null

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

Issue key

issueKey - text

Key of the issue in the issue tracker.

Title

title - text

Title of the issue.

Description

description - text | null

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

Issue status

status - IssueStatus | null

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

Started at

startedAt - timestamp | null

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

Completed at

completedAt - timestamp | null

Time the issue was completed.

Final status at

finalStatusAt - timestamp | null

Time the issue’s status was last changed.

Source created at

createdAt - timestamp

Time the issue was created in the issue tracker.

Source updated at

updatedAt - timestamp

Time the issue was last updated in the issue tracker.

Cycle time

totalCycleTime - timestampMultirange | null

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

In progress

inProgressTime - timestampMultirange | null

Time the issue has been in progress.

Scope increase

scopeIncrease - double | 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

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

Labels

labels - Array<text>

Any labels assigned to the issue.

Timestamp

timestamp - timestamp

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

Estimate

estimate - double | null

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

Flow efficiency

flowEfficiency - percentage

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 (1-N)

Authors who have ever been assigned to the issue.

Assignee

assignee - Author (1-1)

Author assigned to the issue.

Parent issue

parentIssue - Issue (1-1)

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

Children

children - Issue (1-N)

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

Owner teams

ownerTeams - Team (1-N)

Teams owning this issue.

Ancestor issues

ancestorIssues - Issue (1-N)

All ancestor issues up the parent chain.

All linked pull requests

allLinkedPullRequests - Pull request (1-N)

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

Linked pull requests

linkedPullRequests - Pull request (1-N)

Pull requests linked to this issue.

Aggregates

In progress, avg.

averageWorkInProgress - double | null

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

This page is automatically generated

Last updated

Was this helpful?