Skip to main content

Issues and PRs > Key

Tom Williams avatar
Written by Tom Williams
Updated over 2 weeks ago

Dataset: Issues & Pull Requests

Entity: Pull Requests, Issues

Field ID: key

Type: Text

Description: The URL-friendly reference to the issue (e.g., Jira issue key) or pull request (e.g., PR number).

Source: App

Transformation logic: N/A

From:

Github (PRs, Issues)

number

Gitlab (PRs, Issues)

iid (MR or issue number)

Bitbucket (PRs)

id

Azure DevOps (PRs, Issues)

Pull Requests: pullRequestId
​Issues: id

JIRA (Issues)

key

ClickUp (Issues)

id

Trello (Issues)

idShort

Reporting Use Cases

The Key field provides the most common, human-friendly identifier for an item, such as a Jira issue key (e.g., "PROJ-123") or a pull request number. This makes it an essential field for filtering, providing context in reports, and performing advanced analysis through custom formulas.

  • Filtering and Direct Lookups: The key is the most straightforward way to find a specific work item you know by its identifier.

    • To investigate a specific Jira ticket, you can use a filter like Key = "PROJ-1234".

    • To find a specific pull request, you can filter by its number, such as Key = "567".

  • Context in Reports: In any list-based widget, including the key as a dimension is crucial. It displays the identifier that your team uses in conversations, commit messages, and branch names, making the report immediately understandable and easy to cross-reference.

  • Custom Formulas for Advanced Grouping: Because Jira keys have a predictable structure, you can use custom formulas to extract valuable information for reporting.

    • Grouping by Jira Project: You can analyze your workload by Jira project (which may be different from the Git repository) by creating a dimension that extracts the project prefix from the key. The formula REGEX_EXTRACT(key, "^[A-Z]+") will return "PROJ" from "PROJ-1234", allowing you to build charts that show the number of issues per Jira project key.

Did this answer your question?