Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.

To review the current limitations, see Limitations and considerations.

To share feedback or report an issue, visit the Atlassian developer community.

Represents an update or progress report for an Atlassian goal. Goal updates track progress, changes in status, or milestone achievements for specific goals.

Available fields and properties

The Teamwork Graph API has the following fields and properties that you can use in your queries:

Object type fields are the core data fields of the object. Use these when you want to retrieve specific information about the object in your queries.
Cypher query properties are metadata properties used for filtering and traversing relationships between different object types in Teamwork Graph. Use Cypher query properties when you need to filter or navigate relationships between this object and other objects in your queries.

Object type fields

Cypher query properties

Object type fields

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Atlassian goal update.

Field	Type	Description
`createdAt`	`DateTime`	The date and time when the goal update was originally created.
`creator`	`User`	The user object representing the person who created this goal update.
`editedAt`	`DateTime`	The date and time when the goal update was last edited or modified.
`id`	`ID!`	ID in an ARI format. An Atlassian Resource Identifier (ARI) is a globally unique identifier used across Atlassian apps and services for the unique identification of content.
`lastEditor`	`User`	The user object representing the person who last edited this goal update.
`missedUpdate`	`Boolean!`	Indicates whether this update represents a missed scheduled update that was not provided on time.
`newDueDateEndedAt`	`DateTime`	The new end of the range for the due date, if the goal's due date was updated.
`newDueDateStartedAt`	`DateTime`	The new start of the range for the due date, if the goal's due date was updated.
`newScore`	`Int!`	The new score or progress value assigned to the goal in this update.
`newState`	`GoalState`	The new state that the goal was moved to, if the state was changed.
`summary`	`String`	A text summary or description of the changes made in this goal update.
`targetDateAt`	`DateTime`	The target date for when the goal should be completed or achieved.
`updateType`	`UpdateType`	Indicates whether this update was created by a user or automatically by the system.
`url`	`URL`	The URL link to view the goal update in the Atlassian web interface.

Values for GoalState

Value	Description
`ARCHIVED`	The goal is archived
`AT_RISK`	The goal is at risk
`CANCELLED`	The goal is cancelled
`DONE`	The goal is done
`OFF_TRACK`	The goal is off track
`ON_TRACK`	The goal is on track
`PAUSED`	The goal is paused
`PENDING`	The goal is pending

Values for UpdateType

Value	Description
`SYSTEM`	The update was created by the system
`USER`	The update was created by a user

Available relationships

The following relationships are currently supported for Atlassian goal update:

To relationships

Relationships where Atlassian goal update is the target object.

Relationship name	From object type	To object type
Atlassian goal has Atlassian goal update	Atlassian goal	Atlassian goal update
Atlassian user viewed Atlassian goal update	Atlassian user	Atlassian goal update
Content entity links entity	Confluence blog post Confluence comment Confluence page Jira work item Jira work item comment External branch External build External calendar event External comment External commit External conversation External data table External deployment External design External document External messages External project External pull request External repository External video External vulnerability External work item	Atlassian goal update