Skip to content

Commit d7db750

Browse files
kelsey-brownkelsey-brown
authored
Add docs for csv export.mdx
Adding documentation for the CSV export feature of Sourcegraph Analytics.
1 parent 3bdaeb6 commit d7db750

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

‎docs/analytics/index.mdx‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,44 @@ _As of Sourcegraph version 5.10, commands are being deprecated in favor of our n
111111
| Cody commands by day | Daily count of command executions |
112112
| Cody command users | Daily count of command users |
113113
| Most used commands | Ranking of most frequently used Cody commands during the selected time |
114+
115+
116+
### CSV export
117+
118+
You can download underlying user activity data from Sourcegraph Analytics as a CSV export. To do this, click the `Export user-level data` button located at the top right of any tab within the portal.
119+
120+
When exporting, you can group the data by:
121+
1. User
122+
2. User and month
123+
3. User and day
124+
4. User, day, client, and language
125+
126+
Each row in the CSV represents a user's activity for a specific combination of these groupings (e.g., a particular day, month, client, and/or language). The CSV includes metrics such as searches, code navigation actions, chat conversations, code completions, and more.
127+
128+
#### Important Notes
129+
- Not all billable actions are included: Some Sourcegraph features-such as code monitors and batch changes-are not yet represented as columns in the CSV export. We plan to add these fields soon. For now, if a user engages with these features, their activity may appear as a “blank” row in the export. If a user is listed as an “Active Sourcegraph User” (see column D), but the rest of the row is blank, this means they performed a billable action that isn’t currently tracked in the CSV.
130+
- A zero or blank value in a row can also mean that the user did not perform any of the tracked actions for that specific date, client, or language.
131+
132+
| Column Name | Description |
133+
|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
134+
| Instance user ID | Unique identifier assigned to each user in the system. |
135+
| User Email | Email address associated with the user's account. For self-hosted instances, customer must sign the user metadata export addendum for this column to populate. |
136+
| Username | User's login identifier, usually matches the username from the auth provider (e.g., GitHub). For self-hosted instances, customer must sign the user metadata export addendum for this column to populate. |
137+
| Active Sourcegraph User | Indicates if the user activity in this row is considered billable. [Read more](/admin/pricing#billable-active-users) |
138+
| Client Name | Name of the client application or interface used. Common values: <br> - `[IDE_name].cody`: Cody extension interactions from IDEs. <br> - `server.web`: Interactions with the web interface (e.g., searches, code navigation, insights, and some chat events). Variations like `server.svelte-web` may exist. |
139+
| Timestamp Date (or Month) | When the activity was recorded. |
140+
| Language | Programming language of the interaction. This is only recorded for a subset of events, mostly completion and code navigation, and will therefore be blank for many rows. |
141+
| Searches | Number of search queries performed by the user in the web UI. Searches via other methods (e.g., API) are not captured here. |
142+
| Code Navigation Events | Number of times the user navigated through code structures (e.g., "find references", "go to definition"). |
143+
| Code Insight Views | Number of times a code insight was viewed. |
144+
| Chat Events | Number of Cody chats executed. |
145+
| Command Events | Number of Cody commands executed. |
146+
| Combined Completion Suggestions | Number of code completion suggestions offered. |
147+
| Combined Completion Acceptances | Number of code completions accepted by the user. |
148+
| Total Accepted Char Count | Sum of characters from the user’s accepted code completions (includes both full and partial acceptances). |
149+
| Combined CAR | Completion acceptance rate (ratio of accepted to suggested completions), combined across editors. |
150+
| Weighted CAR | Similar to CAR, but weighted by the number of characters presented in the completion. Gives more weight to accepted completions with more code. |
151+
| Total Characters Written by Cody | Inserted code that Cody generates via chat, prompt responses, accepted autocompletions, or suggestions/fixes. Used as the numerator in the "Percentage of Code Written by Cody" ratio. |
152+
| Total Characters Written | Total new code inserted into the editor (includes both user-generated and Cody-generated characters). Used as the denominator in the "Percentage of Code Written by Cody" ratio. |
153+
| Percentage of Code Written by Cody | Measures Cody's impact: (Total Characters Written by Cody ÷ Total Characters Written) × 100. [Learn more about this metric.](/analytics/pcw) |
154+

0 commit comments

Comments
 (0)