View all methods

snapshots.dxiScores.breakdown

Get Developer Experience Index (DXI) scores for a completed snapshot by team, group, or attribute.

This method breaks down DXI.

Facts

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

Arguments

Required arguments

Optional arguments

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.

DXI uses the main branch’s drivers. A supplied branch_ids filter must include the main branch. branch is not a supported breakdown dimension.

Breakdown behavior

For snapshotTeam, the default rows are the snapshot’s root teams, with descendants rolled up. If there is a single root team with children, the default rows are its children. Set parent_snapshot_team_id to drill into a team’s direct children. Population filters continue to apply within each row.

For attribute, set attribute_group_id to the category to break down, such as Location. attribute_ids filters the population; it does not choose the breakdown category. Group rows represent user groups. People can belong to more than one group, so row counts are not necessarily additive.

Example request

curl -X GET 'https://api.getdx.com/snapshots.dxiScores.breakdown?snapshot_id=MjUyNbaY&dimension_type=snapshotTeam' \
  -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": [],
    "dimension_type": "snapshotTeam",
    "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
        }
      }
    ]
  },
  "results": [
    {
      "dimension": {
        "type": "snapshotTeam",
        "id": "NTIzMTM",
        "name": "Integrations"
      },
      "score": 75,
      "hidden": false,
      "total_respondents": 4
    }
  ]
}

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.

The filters also include dimension_type and drivers (the main branch’s DXI driver metadata, including drivers unanswered by this population). attribute_group (id, name, type) is included for attribute breakdowns; parent_snapshot_team (id, name) is included when a parent is selected.

Result object

Field	Type	Description
dimension	Object	The row identity: type, id, and name.
score	Integer or null	Rounded average of the relevant scored DXI drivers. null when hidden or no numeric score exists.
total_respondents	Integer	Largest response count among the row’s DXI drivers, including N/A; this is the count used for the row’s threshold.
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

A row is hidden when its DXI value is null and total_respondents is below the account’s minimum response threshold. total_respondents is the largest per-driver response count in the row, including N/A answers. Driver metadata in filters.drivers remains available. Unlike the aggregate endpoint, each dimension has one score across its relevant drivers, with no separate result per scale.

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.