Atlassian Compass

Atlassian Compass is a developer experience platform that helps engineering teams understand, manage, and improve the health of their software components and services. It provides a centralized catalog of software components with scorecards, metrics, dependency tracking, and event ingestion to improve developer productivity and software quality. Compass exposes a GraphQL API for querying and mutating component data and a REST Operations API for integrations.

2 APIs 6 Features

AtlassianComponent ManagementDeveloper ExperienceSoftware CatalogGraphQL

APIs

Atlassian Compass GraphQL API

The Compass GraphQL API enables programmatic management of software components, scorecards, metrics, relationships, custom fields, and event ingestion within the Compass develop...

Atlassian Compass REST API

The Compass REST API v1 provides operations for component management, scorecard configuration, and webhook registration via standard HTTP REST conventions with OAuth 2.0 authent...

Collections

Atlassian Compass REST API

OPEN

GraphQL

Atlassian Compass GraphQL API

The Compass GraphQL API enables programmatic management of software components, scorecards, metrics, relationships, custom fields, and event ingestion within the Compass develop...

GRAPHQL

Pricing Plans

Atlassian Compass Plans Pricing

3 plans

PLANS

Rate Limits

Atlassian Compass Rate Limits

5 limits

RATE LIMITS

FinOps

Atlassian Compass Finops

FINOPS

Features

Component Catalog

Central catalog of all software components with metadata, ownership, and lifecycle tracking across teams.

Scorecards

Configurable scorecards that evaluate components against engineering standards and best practices to measure health.

Event Ingestion

Ingest build, deployment, incident, and vulnerability events from CI/CD pipelines and monitoring tools via webhooks and REST.

Dependency Tracking

Track relationships and dependencies between software components to understand blast radius and system topology.

Custom Fields

Extend component metadata with custom text, number, boolean, and user fields to capture team-specific data.

Forge Integration

Build custom Compass apps using the Atlassian Forge platform with the GraphQL toolkit for deep platform integration.

Use Cases

Software Catalog Management

Register and track all microservices, libraries, and software components with ownership and lifecycle metadata.

Engineering Health Monitoring

Create scorecards to measure and improve engineering standards like on-call coverage, documentation, and security posture.

DORA Metrics Tracking

Ingest deployment and incident events to track DORA metrics including deployment frequency and change failure rate.

Dependency Mapping

Map dependencies between services to identify coupling, blast radius, and architectural debt.

Developer Portal Integration

Integrate Compass with internal developer portals and CI/CD pipelines for automated component registration and event tracking.

Integrations

Jira

Native integration with Jira for linking components to project tracking and incident management workflows.

Bitbucket

Connect Bitbucket repositories to Compass components for automated code health and deployment event tracking.

GitHub

Integrate GitHub repositories and GitHub Actions CI/CD pipelines with Compass component events.

PagerDuty

Ingest PagerDuty incident events into Compass for on-call and incident tracking scorecard criteria.

Datadog

Connect Datadog monitoring data and deployment events to Compass component metrics.

Terraform

Manage Compass resources via the Atlassian Operations Terraform provider for infrastructure-as-code workflows.

Solutions

Developer Experience Platform

Provide engineering teams with a centralized platform to understand, manage, and improve the health of their software systems.

Platform Engineering

Enable platform engineering teams to enforce standards, track compliance, and improve developer productivity at scale.

Resources

Documentation

GettingStarted

Authentication

GitHubOrganization

GitHubOrganization

TermsOfService

PrivacyPolicy

ReleaseNotes

Sources

opencollection: 1.0.0
info:
  name: Atlassian Compass REST API
  version: '2.0'
items:
- info:
    name: Metrics
    type: folder
  items:
  - info:
      name: Send a metric value into a metric source
      type: http
    http:
      method: POST
      url: https://api.atlassian.com/compass/v1/metrics
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://auth.atlassian.com/authorize
        accessTokenUrl: https://auth.atlassian.com/oauth/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'Sends a single metric value tied to a Compass component. Rate

      limited to 100 requests per user per minute.

      '
- info:
    name: Events
    type: folder
  items:
  - info:
      name: Send an event into an event source
      type: http
    http:
      method: POST
      url: https://api.atlassian.com/compass/v1/events
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://auth.atlassian.com/authorize
        accessTokenUrl: https://auth.atlassian.com/oauth/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'Sends an event into a Compass event source. Returns 202 Accepted

      and processes the event asynchronously. Rate limited to 100 requests

      per user per minute.

      '
bundled: true