- Notifications
You must be signed in to change notification settings - Fork907
docs: add new doc on how to tag coder users in dx data cloud#17805
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Changes fromall commits
e0ebcff
a5c1949
74a7616
23b4eeb
56e1c14
4c35fac
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Isn't data-cloud.md a very generic name. Should we make it more specific? Like There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. we can rename the file, but the title is I'll let@greg-the-coder and@bpmct 👍 or ✍️ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
# DX Data Cloud | ||
[DX](https://getdx.com) is a developer intelligence platform used by engineering | ||
leaders and platform engineers. | ||
You can tag your Coder users in DX Data Cloud to filter and analyze user activity data to: | ||
- Measure adoption and impact | ||
- Identify feature usage patterns | ||
- Personalize user experiences | ||
- Proactively address issues | ||
## Requirements | ||
- A DX Data Cloud subscription | ||
- Access to Coder user data through the Coder CLI, Coder API, an IdP, or an existing Coder-DX integration | ||
- Coordination with your Data Cloud Customer Success Manager | ||
## Extract Your Coder User List | ||
<div class="tabs"> | ||
You can use the Coder CLI, Coder API, or your Identity Provider (IdP) to extract your list of users. | ||
If your organization already uses the Coder-DX integration, you can find a list of active Coder users directly within DX. | ||
### CLI | ||
Use `users list` to export the list of users to a CSV file: | ||
```shell | ||
coder users list > users.csv | ||
``` | ||
Visit the [users list](../../reference/cli/users_list.md) documentation for more options. | ||
### API | ||
Use [get users](../../reference/api/users.md#get-users): | ||
```bash | ||
curl -X GET http://coder-server:8080/api/v2/users \ | ||
-H 'Accept: application/json' \ | ||
-H 'Coder-Session-Token: API_KEY' | ||
``` | ||
To export the results to a CSV file, you can use the `jq` tool to process the JSON response: | ||
```bash | ||
curl -X GET http://coder-server:8080/api/v2/users \ | ||
-H 'Accept: application/json' \ | ||
-H 'Coder-Session-Token: API_KEY' | \ | ||
jq -r '.users | (map(keys) | add | unique) as $cols | $cols, (.[] | [.[$cols[]]] | @csv)' > users.csv | ||
``` | ||
Visit the [get users](../../reference/api/users.md#get-users) documentation for more options. | ||
### IdP | ||
If your organization uses a centralized IdP to manage user accounts, you can extract user data directly from your IdP. | ||
This is particularly useful if you need additional user attributes managed within your IdP. | ||
</div> | ||
## Engage your DX Data Cloud Customer Success Manager | ||
Provide the file to your dedicated DX Data Cloud Customer Success Manager (CSM). | ||
Your CSM will: | ||
1. Import the CSV file into the Data Cloud platform | ||
1. Associate Coder user identifiers with corresponding records in your Data Cloud environment | ||
1. Create the necessary links between your Coder users and their activity data | ||
## Use Coder as a Data Cloud Filter | ||
After the tagging process is complete, you'll have a **Coder** filter option within your Data Cloud dashboards, | ||
reports, and analysis tools that you can use to: | ||
- Segment your data based on Coder usage | ||
- Filter by additional user attributes that are included in your CSV file | ||
- Perform granular analysis on specific segments of your Coder user base | ||
- Understand unique behaviors and patterns across your Coder users | ||
## Related Resources | ||
- [DX Data Cloud Documentation](https://help.getdx.com/en/) | ||
- [Coder CLI](../../reference/cli/users.md) | ||
- [Coder API](../../reference/api/users.md) | ||
- [PlatformX Integration](./platformx.md) |
Uh oh!
There was an error while loading.Please reload this page.