DX

https://docs.getdx.com/
Admin
DX is a platform that provides insights and tools for measuring and managing software development...
Tokens:172,330
Snippets:2,564
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Installation Access Token Response Format

Source: https://docs.getdx.com/connectors/github-projects

Example JSON response containing the installation access token and its associated permissions.

```json
{
  "token": "ghs_abcdef1234567890...",
  "expires_at": "2025-10-28T12:00:00Z",
  "permissions": {
    "metadata": "read",
    "contents": "read",
    "issues": "read",
    "organization_projects": "read"
  }
}
```

--------------------------------

### Configure AWS Profile

Source: https://docs.getdx.com/managed-aws

Example configuration for the ~/.aws/config file to define the setup profile.

```ini
[profile dx-setup]
sso_start_url = https://d-1234567890.awsapps.com/start
sso_region = us-east-1
sso_account_id = 123456789012
sso_role_name = AdministratorAccess
region = us-east-1
output = json
```

--------------------------------

### GET /app/installations

Source: https://docs.getdx.com/connectors/github-actions

Lists the installations of the GitHub App that are accessible to the authenticated user or token.

```APIDOC
## GET /app/installations

### Description
Lists the installations of the GitHub App that are accessible to the authenticated user or token.

### Method
GET

### Endpoint
https://api.github.com/app/installations

### Request Example
curl -H 'Authorization: Bearer YOUR_JWT_TOKEN' -H 'Accept: application/vnd.github.v3+json' 'https://api.github.com/app/installations'
```

--------------------------------

### Install DX Application

Source: https://docs.getdx.com/managed-aws

Execute the installation script to set up databases and application configuration.

```bash
$ ./install.sh
```

--------------------------------

### GET /app/installations

Source: https://docs.getdx.com/connectors/github-security

Lists the installations that the authenticated GitHub App has access to.

```APIDOC
## GET /app/installations

### Description
Lists the installations that the authenticated GitHub App has access to.

### Method
GET

### Endpoint
https://api.github.com/app/installations

### Request Example
curl -H 'Authorization: Bearer YOUR_JWT_TOKEN' -H 'Accept: application/vnd.github.v3+json' 'https://api.github.com/app/installations'
```

--------------------------------

### Chart Configuration Examples

Source: https://docs.getdx.com/webapi/types/studio-report-tile

Examples of chart_config objects based on the selected chart_type.

```json
{"xAxis": "column_1", "yAxes": ["column_2"]}
```

```json
{"labelColumn": "column_1", "valueColumn": "column_2"}
```

```json
{"xAxis": "column_1", "yAxes": ["column_2"], "xAxisLabel": "Column 1 label", "yAxisLabel": "Column 2 label"}
```

```json
{}
```

--------------------------------

### System Property Examples

Source: https://docs.getdx.com/webapi/types/properties

Examples of system-level properties including computed values and file matching rules.

```json
{ "open-prs": 2 }
```

```json
{
  "console-log-statements": {
    "status": "FOUND_MATCHES",
    "match_count": 2,
    "matches": [
      {
        "file_path": "src/main.js",
        "line": 5,
        "output": "console.log(\"Hello world\")",
        "reference_url": "https://example.com/path/to/src/main.js#line-5"
      },
      {
        "file_path": "src/main.js",
        "line": 10,
        "output": "console.log(\"Other log statement\")",
        "reference_url": "https://example.com/path/to/src/main.js#line-10"
      }
    ]
  }
}
```

--------------------------------

### GET /app/installations/{installation_id}

Source: https://docs.getdx.com/connectors/github-security

Retrieves details and permissions for a specific GitHub App installation.

```APIDOC
## GET /app/installations/{installation_id}

### Description
Retrieves details and permissions for a specific GitHub App installation.

### Method
GET

### Endpoint
https://api.github.com/app/installations/{installation_id}

### Parameters
#### Path Parameters
- **installation_id** (string) - Required - The ID of the installation to check.

### Request Example
curl -H 'Authorization: Bearer YOUR_JWT_TOKEN' -H 'Accept: application/vnd.github.v3+json' 'https://api.github.com/app/installations/YOUR_INSTALLATION_ID'
```

--------------------------------

### Install Prerequisites via Homebrew

Source: https://docs.getdx.com/managed-aws

Commands to install necessary CLI tools on MacOS.

```bash
$ brew install awscli
```

```bash
$ brew tap hashicorp/tap
$ brew install hashicorp/tap/terraform
```

```bash
$ brew install kubectl
```

```bash
$ brew install helm
```

```bash
$ brew install git
```

```bash
$ brew install jq
```

--------------------------------

### Capture installer log on Windows

Source: https://docs.getdx.com/ai-code-insights/troubleshooting

Command to generate an installation log file when running the MSI installer.

```powershell
msiexec /i <installer>.msi /l*v install.log
```

--------------------------------

### GET /app/installations/{installation_id}

Source: https://docs.getdx.com/connectors/github-deployments

Retrieves details for a specific GitHub App installation, including the permissions granted to the app.

```APIDOC
## GET /app/installations/{installation_id}

### Description
Retrieves details for a specific GitHub App installation, including the permissions granted to the app.

### Method
GET

### Endpoint
https://api.github.com/app/installations/{installation_id}

### Parameters
#### Path Parameters
- **installation_id** (string) - Required - The ID of the GitHub App installation.

### Request Example
curl -H 'Authorization: Bearer YOUR_JWT_TOKEN' -H 'Accept: application/vnd.github.v3+json' 'https://api.github.com/app/installations/YOUR_INSTALLATION_ID'
```

--------------------------------

### Install the DX CLI

Source: https://docs.getdx.com/cli

Installs the DX CLI globally using npm. Requires Node v20 or later.

```shell
npm install -g @get-dx/cli
```

--------------------------------

### Multi-select Property Example

Source: https://docs.getdx.com/webapi/types/properties

Example of a multi-select property using an array of strings.

```json
{
  "language": ["Ruby", "HTML", "Shell"]
}
```

--------------------------------

### Generate Installation Access Token

Source: https://docs.getdx.com/connectors/github-projects

Exchanges a JWT for a short-lived installation access token required for subsequent API requests.

```bash
curl -X POST -H 'Authorization: Bearer YOUR_JWT_TOKEN' -H 'Accept: application/vnd.github.v3+json' 'https://api.github.com/app/installations/YOUR_INSTALLATION_ID/access_tokens'
```

--------------------------------

### Check GitHub App Installation Permissions

Source: https://docs.getdx.com/connectors/github-security

Retrieve the specific permissions for a given installation ID to ensure the app has the necessary access levels.

```bash
curl -H 'Authorization: Bearer YOUR_JWT_TOKEN' -H 'Accept: application/vnd.github.v3+json' 'https://api.github.com/app/installations/YOUR_INSTALLATION_ID'
```

--------------------------------

### Communication Property Examples

Source: https://docs.getdx.com/webapi/types/properties

Examples of communication-related properties including user, email, and channel integrations.

```json
{ "on-call-owner": "jane@example.com" }
```

```json
{ "alert-email": "team@example.com" }
```

```json
{
  "alert-channel": {
    "channel_id": "C012AB3CD",
    "channel_name": "platform-alerts"
  }
}
```

```json
{
  "alert-channel": {
    "channel_id": "19:abc123@thread.tacv2",
    "channel_name": "platform-alerts"
  }
}
```

```json
{
  "api-docs": {
    "openapi": "3.0.0",
    "info": {
      "title": "My API",
      "version": "1.0.0"
    },
    "paths": {}
  }
}
```

--------------------------------

### Verify GitHub App Installations

Source: https://docs.getdx.com/connectors/github-security

Use the generated JWT token to list all installations accessible to the GitHub App.

```bash
curl -H 'Authorization: Bearer YOUR_JWT_TOKEN' -H 'Accept: application/vnd.github.v3+json' 'https://api.github.com/app/installations'
```

--------------------------------

### Calculate Driver Score Example

Source: https://docs.getdx.com/knowledgebase/why-does-dx-use-percent-favorable

A practical example demonstrating the calculation of a 50% favorable score for a team of 10 respondents.

```text
Score: (3 + 2) ÷ 10 × 100 = 50% favorable
```

--------------------------------

### Initialize the DX CLI

Source: https://docs.getdx.com/cli

Authenticates the user and optionally installs the agent skill.

```shell
dx init
```

--------------------------------

### GET /orgs/{org}/projects

Source: https://docs.getdx.com/connectors/github-projects

Verifies that the GitHub App installation has permission to view projects under the specified organization.

```APIDOC
## GET /orgs/{org}/projects

### Description
Retrieves a list of projects for the specified organization to verify access permissions.

### Method
GET

### Endpoint
https://api.github.com/orgs/{org}/projects

### Parameters
#### Path Parameters
- **org** (string) - Required - The name of the organization.
```

--------------------------------

### GET /orgs/{org}/repos

Source: https://docs.getdx.com/connectors/github-projects

Verifies that the GitHub App installation has permission to view repositories under the specified organization.

```APIDOC
## GET /orgs/{org}/repos

### Description
Retrieves a list of repositories for the specified organization to verify access permissions.

### Method
GET

### Endpoint
https://api.github.com/orgs/{org}/repos

### Parameters
#### Path Parameters
- **org** (string) - Required - The name of the organization.
```

--------------------------------

### Example deployment event sequence

Source: https://docs.getdx.com/datacloudapi/methods/deployments.setPullServices

A chronological sequence of events illustrating how service-level attribution works when using the setPullServices method.

```text
10 am - merge PR#1 (changes service_a)
11 am - merge PR#2 (changes service_b)
12 pm - merge PR#3 (changes service_a)
12:01 - deploy service_a
```

--------------------------------

### GitHub App Installation URLs

Source: https://docs.getdx.com/connectors/github-deployments

Use these URLs to pre-populate the GitHub App creation form with the required permissions for DX.

```text
https://github.com/enterprises/ENTERPRISE_NAME/settings/apps/new?public=false&url=https://getdx.com&metadata=read&actions=read&deployments=read&issues=read&pull_requests=read&members=read&request_oauth_on_install=false&setup_on_update=false&webhook_active=false
```

```text
https://github.com/organizations/ORGANIZATION_NAME/settings/apps/new?public=false&url=https://getdx.com&metadata=read&deployments=read&issues=read&pull_requests=read&members=read&organization_administration=read&request_oauth_on_install=false&setup_on_update=false&webhook_active=false
```

--------------------------------

### Join custom data with connector data

Source: https://docs.getdx.com/custom-tables

A comprehensive example showing table creation, indexing, data insertion, and joining with connector tables like 'deployments'.

```sql
-- Create the table
CREATE TABLE custom.deployment_approvals (
  id            SERIAL PRIMARY KEY,
  deployment_id TEXT NOT NULL,
  approver      TEXT,
  approved_at   TIMESTAMPTZ NOT NULL,
  source_system TEXT DEFAULT 'internal-approval-tool'
);

-- Add indexes for time-based and join-heavy queries
CREATE INDEX idx_deployment_approvals_approved_at
  ON custom.deployment_approvals (approved_at);
CREATE INDEX idx_deployment_approvals_deployment_id
  ON custom.deployment_approvals (deployment_id);

-- Load data
INSERT INTO custom.deployment_approvals (deployment_id, approver, approved_at)
VALUES ('deploy-1234', 'alice', '2025-03-01T10:00:00Z');

-- Join with connector data in a Data Studio report
SELECT d.id, d.environment, a.approver, a.approved_at
FROM deployments d
JOIN custom.deployment_approvals a ON a.deployment_id = d.id
WHERE d.completed_at >= NOW() - INTERVAL '7 days';
```

--------------------------------

### GET teams.info

Source: https://docs.getdx.com/scopes

Get team details.

```APIDOC
## GET teams.info

### Description
Get team details.

### Method
GET

### Endpoint
teams.info
```

--------------------------------

### Create a deployment via cURL

Source: https://docs.getdx.com/datacloudapi/overview

Example of sending a POST request to the deployments.create method using JSON data.

```bash
curl -X POST https://yourinstance.getdx.net/api/deployments.create \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer xxxx-xxxxxxxxx-xxxx" \
   --data '{
    "reference_id": "globally-unique-identifier",
    "deployed_at": 1680723287,
    "service": "my_service",
    "commit_sha": "d1a34f0"
  }'
```

--------------------------------

### GET snapshots.info

Source: https://docs.getdx.com/scopes

Get detailed results for a Snapshot.

```APIDOC
## GET snapshots.info

### Description
Get detailed results for a Snapshot.

### Method
GET

### Endpoint
snapshots.info
```

--------------------------------

### POST /app/installations/{installation_id}/access_tokens

Source: https://docs.getdx.com/connectors/github-projects

Exchanges a JWT for a short-lived installation access token required for subsequent API requests.

```APIDOC
## POST /app/installations/{installation_id}/access_tokens

### Description
Exchanges your JWT for an installation access token to authenticate as a GitHub App installation.

### Method
POST

### Endpoint
https://api.github.com/app/installations/{installation_id}/access_tokens

### Parameters
#### Path Parameters
- **installation_id** (string) - Required - The ID of the GitHub App installation.

### Response
#### Success Response (200)
- **token** (string) - The installation access token.
- **expires_at** (string) - The expiration timestamp of the token.
- **permissions** (object) - The permissions granted to the token.
```

--------------------------------

### GET https://api.getdx.com/initiatives.progressReport

Source: https://docs.getdx.com/webapi/methods/initiatives.progressReport

Get progress report for an initiative showing entity-level task completion.

```APIDOC
## GET https://api.getdx.com/initiatives.progressReport

### Description
Get progress report for an initiative showing entity-level task completion.

### Method
GET

### Endpoint
https://api.getdx.com/initiatives.progressReport

### Parameters
#### Query Parameters
- **token** (Token) - Required - Auth token passed as an HTTP header.
- **id** (String) - Required - Initiative public ID.
- **entity_type_identifiers** (String) - Optional - Comma-separated entity type identifiers to filter by.
- **limit** (Integer) - Optional - Limit the number of entities per page. Maximum 100, defaults to 50.
- **cursor** (String) - Optional - Cursor used to request the next page.

### Request Example
curl -X GET "https://api.getdx.com/initiatives.progressReport?id=qypefayqpvnf&limit=10" \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'

### Response
#### Success Response (200)
- **ok** (Boolean) - Status of the request.
- **entities** (Array) - List of entity progress objects.
- **response_metadata** (Object) - Metadata including next_cursor.

#### Response Example
{
  "ok": true,
  "entities": [
    {
      "name": "Payment Service",
      "identifier": "payment-service",
      "description": "Handles payment processing",
      "entity_type_identifier": "service",
      "total_tasks": 8,
      "completed_tasks": 6,
      "overdue_tasks": 1,
      "due_soon_tasks": 1,
      "remaining_dev_days": 2.5
    }
  ],
  "response_metadata": {
    "next_cursor": "auth-service"
  }
}
```

--------------------------------

### Initialize and Authenticate Managed Deployments

Source: https://docs.getdx.com/cli

Configure the CLI for managed environments by setting custom base URLs for interactive and non-interactive workflows.

```shell
# Interactive login
DX_WEB_BASE_URL="https://dx.some-example-subdomain.example.com" DX_API_BASE_URL="https://api.dx.some-example-subdomain.example.com" dx init

# Non-interactive use for CI, containers, or remote agents
DX_WEB_BASE_URL="https://dx.some-example-subdomain.example.com" DX_API_BASE_URL="https://api.dx.some-example-subdomain.example.com" DX_API_TOKEN="$DX_TOKEN" dx auth login
```

--------------------------------

### Provision Infrastructure

Source: https://docs.getdx.com/managed-aws

Standard Terraform commands to initialize, plan, and apply infrastructure changes.

```bash
terraform init
```

```bash
terraform plan
```

```bash
terraform apply
```

--------------------------------

### Define a Studio Report Tile

Source: https://docs.getdx.com/webapi/types/studio-report-tile

Example structure of a report tile including SQL and chart configuration.

```json
{
  "id": "MTE4e2",
  "title": "Median visit duration",
  "sql": "SELECT avg(duration) AS avg_duration, week_start FROM custom.web_visits;",
  "chart_type": "line",
  "chart_config": {
    "xAxis": "week_start",
    "yAxes": ["avg_duration"]
  }
}
```

--------------------------------

### Initialize and Authenticate Dedicated Deployments

Source: https://docs.getdx.com/cli

Configure the CLI for dedicated environments by setting custom base URLs for interactive and non-interactive workflows.

```shell
# Interactive login
DX_WEB_BASE_URL="https://mycompany.getdx.io" DX_API_BASE_URL="https://api.mycompany.getdx.io" dx init

# Non-interactive use for CI, containers, or remote agents
DX_WEB_BASE_URL="https://mycompany.getdx.io" DX_API_BASE_URL="https://api.mycompany.getdx.io" DX_API_TOKEN="$DX_TOKEN" dx auth login
```

--------------------------------

### Enable Tool Detail Logging

Source: https://docs.getdx.com/connectors/claude-code-otel

Set this environment variable to track specific skill names instead of generic labels.

```text
OTEL_LOG_TOOL_DETAILS: "1"
```

--------------------------------

### Single Field Property Examples

Source: https://docs.getdx.com/webapi/types/properties

Examples of basic single-field property types including URL, text, boolean, number, and date.

```json
{ "slack-team": "https://company.slack.com/archive/2394kfl3" }
```

```json
{ "note": "Do not deploy" }
```

```json
{ "approved": true }
```

```json
{ "q3-incidents": 12 }
```

```json
{ "reviewed_on": "2025-01-12" }
```

--------------------------------

### Account settings response examples

Source: https://docs.getdx.com/webapi/methods/accountsettings.info

Successful responses return account SSO configurations and session settings, varying based on the protocol (SAML or OIDC).

```json
{
  "ok": true,
  "sso": [
    {
      "name": "Okta",
      "protocol": "saml",
      "login_required": true,
      "jit_provisioning_enabled": false,
      "metadata_uri": "https://idp.example.com/metadata"
    }
  ],
  "session": {
    "timeout_hours": 48
  }
}
```

```json
{
  "ok": true,
  "sso": [
    {
      "name": "Google",
      "protocol": "oidc",
      "login_required": true,
      "jit_provisioning_enabled": false,
      "issuer_url": "https://accounts.example.com",
      "client_id": "client_abc"
    }
  ],
  "session": {
    "timeout_hours": 48
  }
}
```

--------------------------------

### Multiple Field Property Examples

Source: https://docs.getdx.com/webapi/types/properties

Examples of property types that support multiple values or complex structures, such as select, multi-select, list, and JSON.

```json
{ "service-tier": "Tier-1" }
```

```json
{ "languages": ["Ruby", "Javascript"] }
```

```json
{ "frameworks": ["React", "Rails", "GraphQL"] }
```

```json
{ "json_config": { "key1": "value1", "array": [0, 1, 2] } }
```

--------------------------------

### GET teams.list

Source: https://docs.getdx.com/scopes

List teams.

```APIDOC
## GET teams.list

### Description
List teams.

### Method
GET

### Endpoint
teams.list
```

--------------------------------

### GET teams.findByMembers

Source: https://docs.getdx.com/scopes

Find a team by its members.

```APIDOC
## GET teams.findByMembers

### Description
Find a team by its members.

### Method
GET

### Endpoint
teams.findByMembers
```
Tokens:
Raw