The DX Engineering Intelligence Platform is our latest solution in tracking developer productivity & experience, measuring AI impact, and understanding overall software health. As we focus on delivering these next-generation IDP capabilities, Compass scorecards and catalog functionality will transition into DX. We encourage you to explore DX and discuss migration options with your account manager.

Learn more

Use the GraphQL API toolkit

The GraphQL API toolkit provides methods for making common requests to the Atlassian GraphQL Gateway from a Forge app.

Before you begin

To access GraphQL APIs from your app, install the latest GraphQL API Toolkit package by running:

1
2
npm install @atlassian/forge-graphql

Use the GraphQL API toolkit

Import the @atlassian/forge-graphql package into your Forge app:

1
2
import graphqlGateway from "@atlassian/forge-graphql";

The following example request uses the getComponent method to fetch details about a Compass component. When executing this code, define a componentId variable, which you can find on any component on your Compass site.

1
2
const {
  errors,
  data
} = await graphqlGateway.compass.asApp().getComponent({ componentId });

To view the full documentation for the GraphQL API toolkit, visit the reference documentation.