The Teamwork Graph API is available through Forge's Early Access Program (EAP).
EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice.
You must only install apps that call the Teamwork Graph API in test organizations. Apps calling
the Teamwork Graph API require the read:graph:jiraor read:graph:confluence scope, which provides access to Teamwork Graph
data across your entire organization. While apps still respect end-user permissions, this scope may
grant access to sensitive information. For safety, only install these apps in organizations with test
data unless you have an approved path to production.
Additionally, this EAP has significant limitations. To review the full list of limitations, see Limitations and considerations.
You must be part of this EAP in order to use the Teamwork Graph API. Express interest in joining through this form.
Represents a focus area from Mercury, aggregating status, metadata, and change summaries.
The Teamwork Graph API has the following fields and properties that you can use in your queries:
You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Focus focus area.
| Field | Type | Description |
|---|---|---|
aggregatedFocusAreaStatusCount | FocusFocusAreaStatusCountAggregate | Get aggregated Focus Area status counts |
archived | Boolean | Indicates if Focus Area is Archived |
createdAt | DateTime | The date the Focus Area was created. |
draft | Boolean | Indicates if the focus area is a draft |
focusAreaType | String | The Focus Area type indicating the Focus Area level in the hierarchy. |
health | String | The health of the Focus Area, e.g. on_track, off_track, at_risk. |
id | ID! | The ID of the Focus Area. |
name | String | The name of the Focus Area. |
owner | User | The owner responsible for the Focus Area. |
status | String | The status of the Focus Area, e.g. pending, in_progress, completed. |
targetDate | FocusFocusAreaTargetDate | The target delivery date of the Focus Area. |
updatedAt | DateTime | The date the any field on the Focus Area was last updated. |
url | URL | URL to the Focus Area |
watching | Boolean | Indicates if the current user is watching the Focus Area. |
| Field | Type | Description |
|---|---|---|
children | FocusFocusAreaStatusCount | Status count aggregations for children |
current | FocusFocusAreaStatusCount | Status count aggregations for current node |
subtree | FocusFocusAreaStatusCount | Status count aggregations for current node and children |
| Field | Type | Description |
|---|---|---|
atRisk | Int | Count of at-risk status |
completed | Int | Count with completed status |
inProgress | Int | Count of in-progress status |
offTrack | Int | Count of off-track status |
onTrack | Int | Count of on-track status |
paused | Int | Count with paused status |
pending | Int | Count with pending status |
total | Int | Total count of nodes |
| Field | Type | Description |
|---|---|---|
atRisk | Int | Count of at-risk status |
completed | Int | Count with completed status |
inProgress | Int | Count of in-progress status |
offTrack | Int | Count of off-track status |
onTrack | Int | Count of on-track status |
paused | Int | Count with paused status |
pending | Int | Count with pending status |
total | Int | Total count of nodes |
| Field | Type | Description |
|---|---|---|
atRisk | Int | Count of at-risk status |
completed | Int | Count with completed status |
inProgress | Int | Count of in-progress status |
offTrack | Int | Count of off-track status |
onTrack | Int | Count of on-track status |
paused | Int | Count with paused status |
pending | Int | Count with pending status |
total | Int | Total count of nodes |
| Field | Type | Description |
|---|---|---|
targetDate | DateTime | The target delivery date of the Focus Area. |
targetDateType | String | The target delivery date type. |
The following relationships are currently supported for Focus focus area:
Relationships where Focus focus area is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| Focus focus area has Atlassian goal | Focus focus area | Atlassian goal |
| Focus focus area has Confluence page | Focus focus area | Confluence page |
| Focus focus area has child Focus focus area | Focus focus area | Focus focus area |
Rate this page: