|
| 1 | +#DX Data Cloud |
| 2 | + |
| 3 | +[DX](https://getdx.com) is a developer intelligence platform used by engineering |
| 4 | +leaders and platform engineers. |
| 5 | + |
| 6 | +DX uses metadata attributes to assign information to individual users. |
| 7 | +While it's common to segment users by`role`,`level`, or`geo`, it’s become increasingly |
| 8 | +common to use DX attributes to better understand usage and adoption of tools. |
| 9 | + |
| 10 | +You can create a`Coder` attribute in DX to segment and analyze the impact of Coder usage on a developer’s work, including: |
| 11 | + |
| 12 | +- Understanding the needs of power users or low Coder usage across the org |
| 13 | +- Correlate Coder usage with qualitative and quantitative engineering metrics, |
| 14 | + such as PR throughput, deployment frequency, deep work, dev environment toil, and more. |
| 15 | +- Personalize user experiences |
| 16 | + |
| 17 | +##Requirements |
| 18 | + |
| 19 | +- A DX subscription |
| 20 | +- Access to Coder user data through the Coder CLI, Coder API, an IdP, or an existing Coder-DX integration |
| 21 | +- Coordination with your DX Customer Success Manager |
| 22 | + |
| 23 | +##Extract Your Coder User List |
| 24 | + |
| 25 | +<divclass="tabs"> |
| 26 | + |
| 27 | +You can use the Coder CLI, Coder API, or your Identity Provider (IdP) to extract your list of users. |
| 28 | + |
| 29 | +If your organization already uses the Coder-DX integration, you can find a list of active Coder users directly within DX. |
| 30 | + |
| 31 | +###CLI |
| 32 | + |
| 33 | +Use`users list` to export the list of users to a CSV file: |
| 34 | + |
| 35 | +```shell |
| 36 | +coder users list> users.csv |
| 37 | +``` |
| 38 | + |
| 39 | +Visit the[users list](../../reference/cli/users_list.md) documentation for more options. |
| 40 | + |
| 41 | +###API |
| 42 | + |
| 43 | +Use[get users](../../reference/api/users.md#get-users): |
| 44 | + |
| 45 | +```bash |
| 46 | +curl -X GET http://coder-server:8080/api/v2/users \ |
| 47 | + -H'Accept: application/json' \ |
| 48 | + -H'Coder-Session-Token: API_KEY' |
| 49 | +``` |
| 50 | + |
| 51 | +To export the results to a CSV file, you can use the`jq` tool to process the JSON response: |
| 52 | + |
| 53 | +```bash |
| 54 | +curl -X GET http://coder-server:8080/api/v2/users \ |
| 55 | + -H'Accept: application/json' \ |
| 56 | + -H'Coder-Session-Token: API_KEY'| \ |
| 57 | + jq -r'.users | (map(keys) | add | unique) as $cols | $cols, (.[] | [.[$cols[]]] | @csv)'> users.csv |
| 58 | +``` |
| 59 | + |
| 60 | +Visit the[get users](../../reference/api/users.md#get-users) documentation for more options. |
| 61 | + |
| 62 | +###IdP |
| 63 | + |
| 64 | +If your organization uses a centralized IdP to manage user accounts, you can extract user data directly from your IdP. |
| 65 | + |
| 66 | +This is particularly useful if you need additional user attributes managed within your IdP. |
| 67 | + |
| 68 | +</div> |
| 69 | + |
| 70 | +##Contact your DX Customer Success Manager |
| 71 | + |
| 72 | +Provide the file to your dedicated DX Customer Success Manager (CSM). |
| 73 | + |
| 74 | +Your CSM will import the CSV of individuals using Coder, as well as usage frequency (if applicable) into DX to create a`Coder` attribute. |
| 75 | + |
| 76 | +After the attribute is uploaded, you'll have a Coder filter option within your DX reports allowing you to: |
| 77 | + |
| 78 | +- Perform cohort analysis (Coder user vs non-user) |
| 79 | +- Understand unique behaviors and patterns across your Coder users |
| 80 | +- Run a[study](https://getdx.com/studies/) or setup a[PlatformX](https://getdx.com/platformx/) event for deeper analysis |
| 81 | + |
| 82 | +##Related Resources |
| 83 | + |
| 84 | +-[DX Data Cloud Documentation](https://help.getdx.com/en/) |
| 85 | +-[Coder CLI](../../reference/cli/users.md) |
| 86 | +-[Coder API](../../reference/api/users.md) |
| 87 | +-[PlatformX Integration](./platformx.md) |