💻 API Documentation

Developer API

Programmatically access your delivery insights, deployment data, and team performance analytics with our REST API.

⚡Coming Q2 2027

Getting Started

The full DXSignal REST API is in active development for Professional and Enterprise plans. Webhook ingestion endpoints (deployments and incidents) are available today.

Authentication

All API requests require authentication using an API key. You'll generate your API key from the Settings page.

# Include your API key in the Authorization header

curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.dxsignal.io/v1/metrics/dora

Base URL

https://api.dxsignal.io/v1

Rate Limits

Professional Plan

1,000 req/hour

Enterprise Plan

5,000 req/hour

Enterprise

Custom

Response Format

All responses are returned in JSON format with standard HTTP status codes.

// Success Response (200 OK)

{
  "success": true,
  "data": { ... },
  "timestamp": "2024-12-01T12:00:00Z"
}

// Error Response (4xx/5xx)

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

API Endpoints

Metrics

Retrieve delivery and performance data

GET/api/v1/metrics/dora

Get all DORA metrics for your organization (Deployment Frequency, Lead Time, Change Failure Rate, MTTR)

GET/api/v1/metrics/deployments

Retrieve deployment history and frequency metrics with filtering and pagination

GET/api/v1/metrics/pull-requests

Get pull request metrics including cycle time, merge rate, and velocity

GET/api/v1/metrics/lead-time

Calculate lead time from commit to deployment with percentile breakdowns

GET/api/v1/metrics/change-failure-rate

Get change failure rate and failed deployment statistics

Teams

Manage teams and compare performance

GET/api/v1/teams

List all teams in your organization

POST/api/v1/teams

Create a new team

GET/api/v1/teams/:teamId/metrics

Get metrics for a specific team

PUT/api/v1/teams/:teamId

Update team details and repository assignments

Integrations

Manage connected platforms and repositories

GET/api/v1/integrations

List all connected integrations (GitHub, GitLab, Azure DevOps, Bitbucket, Jira)

GET/api/v1/repositories

Get all repositories across connected integrations

PUT/api/v1/repositories/:repoId/selection

Update repository selection status for metric tracking

POST/api/v1/integrations/sync

Trigger manual sync for all integrations

Organizations

Organization and subscription management

GET/api/v1/organization

Get current organization details and subscription info

GET/api/v1/organization/members

List all members in your organization

POST/api/v1/organization/invitations

Invite a new member to your organization

GET/api/v1/organization/subscription

Get subscription and billing information

Get Early Access

Want to be among the first to use the DXSignal API? Sign up for early access and we'll notify you when it's ready.

Request Early Access View Roadmap

📧 Email: api@dxsignal.io