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. Do not install apps using this API in organizations with production data while this feature is in EAP.

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 scorecard in Compass that evaluates component health and best practices. Scorecards define criteria and metrics to assess software quality, security, and operational excellence across components.

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

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

Field	Type	Description
`canDeactivate`	`Boolean!`	Indicates whether the scorecard can be deactivated or disabled.
`changeMetadata`	`CompassChangeMetadata!`	Metadata about when and by whom the scorecard was created and last modified.
`componentLabels`	`[String!]`	Labels that categorize components to which this scorecard applies.
`componentTiers`	`[String!]`	The tiers (e.g., critical, high, medium, low) of components to which this scorecard applies.
`componentTypeIds`	`[ID!]!`	The unique identifiers (IDs) of component types to which this scorecard applies.
`description`	`String`	A detailed description of what the scorecard evaluates and its purpose.
`id`	`ID!`	The unique identifier (ID) of the scorecard.
`importance`	`CompassScorecardImportance!`	The importance level of the scorecard, indicating how it should be applied to components.
`name`	`String!`	The display name of the scorecard.
`owner`	`User`	The user object representing the owner or person responsible for this scorecard.
`scoringStrategyType`	`String`	The type of scoring strategy used to calculate the scorecard results.
`state`	`String`	The current state or status of the scorecard (e.g., active, inactive).
`statusConfig`	`CompassScorecardStatusConfig`	Configuration that defines the thresholds for different scorecard status levels.
`type`	`String!`	The type or category of the scorecard.
`url`	`URL`	The URL to view the scorecard in Compass.
`verified`	`Boolean`	Indicates whether the scorecard has been verified or validated.

Fields for CompassChangeMetadata

Field	Type	Description
`createdAt`	`DateTime`	The date and time when the resource was originally created.
`createdBy`	`User`	The user object representing the person who created the resource.
`lastUserModificationAt`	`DateTime`	The date and time when the resource was last modified by a user.
`lastUserModificationBy`	`User`	The user object representing the person who last modified the resource.

Fields for CompassScorecardStatusConfig

Field	Type	Description
`failing`	`CompassScorecardStatusThreshold!`	The threshold configuration for components that are failing the scorecard criteria.
`needsAttention`	`CompassScorecardStatusThreshold!`	The threshold configuration for components that need attention to meet scorecard criteria.
`passing`	`CompassScorecardStatusThreshold!`	The threshold configuration for components that are passing the scorecard criteria.

Fields for CompassScorecardStatusThreshold

Field	Type	Description
`lowerBound`	`Int!`	The lower boundary value for this threshold range (inclusive).
`upperBound`	`Int!`	The upper boundary value for this threshold range (inclusive).

Fields for CompassScorecardStatusThreshold

Field	Type	Description
`lowerBound`	`Int!`	The lower boundary value for this threshold range (inclusive).
`upperBound`	`Int!`	The upper boundary value for this threshold range (inclusive).

Fields for CompassScorecardStatusThreshold

Field	Type	Description
`lowerBound`	`Int!`	The lower boundary value for this threshold range (inclusive).
`upperBound`	`Int!`	The upper boundary value for this threshold range (inclusive).

Values for CompassScorecardImportance

Value	Description
`RECOMMENDED`	Recommended to the component's owner when they select a scorecard to apply to their component.
`REQUIRED`	Automatically applied to all components of the specified type or types and cannot be removed.
`USER_DEFINED`	Custom scorecard, focused on specific use cases within teams or departments.

Available relationships

The following relationships are currently supported for Compass scorecard:

From relationships

Relationships where Compass scorecard is the source object.

Relationship name	From object type	To object type
Compass scorecard has Atlassian goal	Compass scorecard	Atlassian goal