View all methods

snapshots.dxiScores

Get Developer Experience Index (DXI) scores for a completed snapshot.

DXI is the average of the scored DXI drivers from the snapshot’s main branch. Each result includes the drivers and their scores. Drivers without a numeric score in the filtered population are omitted.

If you supply branch_ids, the selection must include the main branch. DX scores the main branch’s DXI drivers over respondents from all selected branches.

Facts
Method GET https://api.getdx.com/snapshots.dxiScores
Required scope snapshots:read

Arguments

Required arguments

Name Type Description
token Token Auth token passed in the Authorization: Bearer HTTP header.
snapshot_id Text ID of a completed snapshot belonging to the account.

Optional arguments

Name Type Description
team_ids Array<Text> Comma-separated team IDs. Each team must be represented in the snapshot. Includes descendants in the snapshot hierarchy.
snapshot_team_ids Array<Text> Comma-separated snapshot team IDs. Each must belong to the snapshot. Includes descendants.
group_ids Array<Text> Comma-separated user group IDs belonging to the account.
branch_ids Array<Text> Comma-separated branch IDs belonging to the snapshot.
attribute_ids Array<Text> Comma-separated attribute value IDs. Values must belong to the account and be accessible to the token.

Filtering behavior

With no population filters, results cover the organization. Values within a filter are combined with OR; different filter types are combined with AND. When both team_ids and snapshot_team_ids are supplied, the selected subtrees are intersected. Disjoint selections match no people.

Attribute values are combined with OR within each attribute group and AND across groups. For example, two Location values and one Role value match people in either location who also have the selected role.

The response includes only the selected filter values. filters.snapshot.completed_count and total_count describe the filtered population, not the whole snapshot. total_count includes eligible recipients and people who completed the snapshot even if excluded from the recipient list.

Example request

curl -X GET 'https://api.getdx.com/snapshots.dxiScores?snapshot_id=MjUyNbaY' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'

Example response

This example uses an account minimum response threshold of 3.

{
  "ok": true,
  "filters": {
    "snapshot": {
      "id": "MjUyNbaY",
      "scheduled_for": "2026-08-02",
      "completed_at": "2026-08-16T14:00:00.000Z",
      "completed_count": 4,
      "total_count": 6
    },
    "teams": [],
    "snapshot_teams": [],
    "groups": [],
    "branches": [],
    "attribute_groups": []
  },
  "results": [
    {
      "is_five_point_scale": true,
      "score": 75,
      "hidden": false,
      "drivers": [
        {
          "id": "MTQ2",
          "name": "Ease of release",
          "prompt": "It is easy to release changes to production.",
          "target_role": "dev",
          "benchmark": {
            "name": "All companies",
            "p_50": 58,
            "p_75": 71,
            "p_90": 83,
            "year": 2026
          },
          "score": 75
        }
      ]
    }
  ]
}

Response fields

Field Type Description
ok Boolean Whether the request succeeded.
filters Object The snapshot, applied population filters, and any breakdown selection.
results Array<Object> Results for the requested population.

Filters object

Field Type Description
snapshot Object id, scheduled_for (YYYY-MM-DD), completed_at (ISO 8601), completed_count, and total_count. Counts reflect the applied population filters.
teams Array<Object> Selected teams, each with id and name; empty when not filtered.
snapshot_teams Array<Object> Selected snapshot teams, each with id and name; empty when not filtered.
groups Array<Object> Selected user groups, each with id and name; empty when not filtered.
branches Array<Object> Selected branches, each with id and name; empty when not filtered.
attribute_groups Array<Object> Groups represented in attribute_ids. Each has id, name, type, and attributes containing only the selected values (id and name). See management types.

Result object

Field Type Description
is_five_point_scale Boolean true for five-point drivers; false for three-point drivers.
drivers Array<Object> Scored drivers for this scale, ordered by name. Each includes driver metadata and a score that is null when hidden.
score Integer or null Rounded average of the relevant scored DXI drivers. null when hidden or no numeric score exists.
hidden Boolean Whether the result is suppressed by the account’s minimum response threshold.

Driver object

Field Type Description
id String The item ID.
name String The item name.
prompt String The question text.
target_role String Audience: dev, nondev, or all.
benchmark Object or null Benchmark metadata, when available.

Benchmark object

benchmark is null when no benchmark is available. Otherwise, it contains name, p_50, p_75, p_90, and year. DX uses the account’s selected benchmark segment, or the default segment when none is selected.

Privacy and missing data

Results are hidden when completed responses in the filtered population are below the account’s minimum response threshold, including responses containing only N/A answers. When hidden, the DXI score and every returned driver’s score are null. Drivers follow the DXI threshold, without a separate per-driver threshold.

Errors

Check ok in every response. When it is false, read error and any error_details.

Field HTTP status Description
not_authed 401 The authentication token is missing or invalid.
not_authorized 403 The token does not have access to this method, including the required snapshots:read scope.
invalid_arguments 400 A required argument is missing or a filter or breakdown argument is invalid. error_details identifies the argument.
not_found 404 The snapshot is unknown, belongs to another account, is deleted, or is not completed.