Skip to content

Commit 53f7a01

Browse files
CopilothollenberryCopilotsophietheking
authored
Document Copilot app usage across the Copilot usage metrics reports (#62483)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hollenberry <13326548+hollenberry@users.noreply.github.com> Co-authored-by: Eric Hollenberry <hollenberry@github.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
1 parent 51a637c commit 53f7a01

3 files changed

Lines changed: 119 additions & 24 deletions

File tree

content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,12 +120,14 @@ Per-user reports contain one record per user for the reporting period. The 28-da
120120
| `used_agent` | `boolean` | No | Whether the user used agent mode in the IDE that day. Does not include {% data variables.copilot.copilot_code-review_short %} activity, which is captured separately in `used_copilot_code_review_active` and `used_copilot_code_review_passive`. |
121121
| `used_chat` | `boolean` | No | Whether the user used IDE chat that day. |
122122
| `used_cli` | `boolean` | No | Whether the user used {% data variables.copilot.copilot_cli_short %} that day. |
123+
| `used_copilot_app` | `boolean` | No | Whether the user used the {% data variables.copilot.github_copilot_app_short %} that day. |
123124
| `used_copilot_coding_agent` | `boolean` | No | Whether the user used {% data variables.copilot.copilot_cloud_agent %} (previously Copilot coding agent) that day. |
124125
| `used_copilot_cloud_agent` | `boolean` | No | Whether the user used {% data variables.copilot.copilot_cloud_agent %} that day. Carries the same value as `used_copilot_coding_agent`; both names are retained for backward compatibility. |
125126
| `used_copilot_code_review_active` | `boolean` | Yes | Whether the user actively engaged with {% data variables.copilot.copilot_code-review_short %} that day. A user is considered active if they manually requested a {% data variables.product.prodname_copilot_short %} review, or applied a {% data variables.product.prodname_copilot_short %} review suggestion. Null when there is no {% data variables.copilot.copilot_code-review_short %} signal for the user that day. |
126127
| `used_copilot_code_review_passive` | `boolean` | Yes | Whether the user had {% data variables.product.prodname_copilot_short %} automatically assigned to review their pull request that day, without actively engaging with the review. Null when there is no {% data variables.copilot.copilot_code-review_short %} signal for the user that day. |
127128
| `ai_adoption_phase` | `object` | No | The user's AI adoption phase for the day. Always present; defaults to the "No Cohort" phase. See [AI adoption phase fields](#ai-adoption-phase-fields). |
128129
| `totals_by_cli` | `object` | Yes | CLI-specific metrics for the user. Omitted when the user had no {% data variables.copilot.copilot_cli_short %} usage that day. See [{% data variables.copilot.copilot_cli_short %} metrics fields](#copilot-cli-metrics-fields). |
130+
| `totals_by_copilot_app` | `object` | Yes | {% data variables.copilot.github_copilot_app_short %} metrics for the user. Omitted when the user had no {% data variables.copilot.github_copilot_app_short %} usage that day. See [{% data variables.copilot.github_copilot_app_short %} metrics fields](#copilot-app-metrics-fields). |
129131
| `totals_by_ide` | `array` | No | Per-IDE breakdown of the user's activity. See [Activity breakdown objects](#activity-breakdown-objects). |
130132
| `totals_by_feature` | `array` | No | Per-feature breakdown of the user's activity. See [Activity breakdown objects](#activity-breakdown-objects). |
131133
| `totals_by_language_feature` | `array` | No | Breakdown combining language and feature dimensions. See [Activity breakdown objects](#activity-breakdown-objects). |
@@ -140,9 +142,9 @@ Active-user counts:
140142

141143
| Field | Type | Nullable | Description |
142144
|:--|:--|:--|:--|
143-
| `daily_active_users` | `integer` | No | Number of unique users who used {% data variables.product.prodname_copilot_short %} on a given day. |
144-
| `weekly_active_users` | `integer` | No | Number of unique users who used {% data variables.product.prodname_copilot_short %} during a trailing seven-day window. |
145-
| `monthly_active_users` | `integer` | No | Number of unique users who used {% data variables.product.prodname_copilot_short %} during a trailing 28-day window. |
145+
| `daily_active_users` | `integer` | No | Number of unique users who used {% data variables.product.prodname_copilot_short %} on a given day, including users active only in the {% data variables.copilot.github_copilot_app_short %}. |
146+
| `weekly_active_users` | `integer` | No | Number of unique users who used {% data variables.product.prodname_copilot_short %} during a trailing seven-day window, including users active only in the {% data variables.copilot.github_copilot_app_short %}. |
147+
| `monthly_active_users` | `integer` | No | Number of unique users who used {% data variables.product.prodname_copilot_short %} during a trailing 28-day window, including users active only in the {% data variables.copilot.github_copilot_app_short %}. |
146148
| `monthly_active_chat_users` | `integer` | No | Number of unique users who used chat during a trailing 28-day window. |
147149
| `monthly_active_agent_users` | `integer` | No | Number of unique users who used agent mode during a trailing 28-day window. |
148150
| `daily_active_copilot_cloud_agent_users` | `integer` | No | Number of unique users who used {% data variables.copilot.copilot_cloud_agent %} on a given day. |
@@ -155,6 +157,7 @@ Active-user counts:
155157
| `weekly_passive_copilot_code_review_users` | `integer` | No | Number of unique users who had {% data variables.copilot.copilot_code-review_short %} automatically assigned to review their pull request during a trailing seven-day window, with no active engagement. |
156158
| `monthly_passive_copilot_code_review_users` | `integer` | No | Number of unique users who had {% data variables.copilot.copilot_code-review_short %} automatically assigned to review their pull request during a trailing 28-day window, with no active engagement. |
157159
| `daily_active_cli_users` | `integer` | Yes | Number of unique users who used {% data variables.copilot.copilot_cli_short %} on a given day. This count is **independent** of IDE active-user counts and is **not** included in IDE-based active-user definitions. Omitted for enterprises or organizations with no CLI usage that day. |
160+
| `daily_active_copilot_app_users` | `integer` | Yes | Number of unique users who used the {% data variables.copilot.github_copilot_app_short %} on a given day. Enterprise reports only. Null when the enterprise has no {% data variables.copilot.github_copilot_app_short %} activity that day. |
158161

159162
Activity totals and breakdowns:
160163

@@ -173,6 +176,7 @@ Activity totals and breakdowns:
173176
| `totals_by_language_model` | `array` | No | Aggregated language-and-model activity breakdown. See [Activity breakdown objects](#activity-breakdown-objects). |
174177
| `totals_by_model_feature` | `array` | No | Aggregated model-and-feature activity breakdown. See [Activity breakdown objects](#activity-breakdown-objects). |
175178
| `totals_by_cli` | `object` | Yes | Aggregated {% data variables.copilot.copilot_cli_short %} metrics for the day. Omitted when there is no CLI usage that day. Unlike the per-user form, it does not include `last_known_cli_version`. See [{% data variables.copilot.copilot_cli_short %} metrics fields](#copilot-cli-metrics-fields). |
179+
| `totals_by_copilot_app` | `object` | Yes | Aggregated {% data variables.copilot.github_copilot_app_short %} metrics for the day. Enterprise reports only. Null when the enterprise has no {% data variables.copilot.github_copilot_app_short %} activity that day. See [{% data variables.copilot.github_copilot_app_short %} metrics fields](#copilot-app-metrics-fields). |
176180
| `totals_by_ai_adoption_phase` | `array` | Yes | Per-phase aggregates of users and their average activity. Omitted when no adoption-phase data is available. See [AI adoption phase fields](#ai-adoption-phase-fields). |
177181
| `pull_requests` | `object` | No | Daily pull request activity for the enterprise or organization. See [Pull request activity fields](#pull-request-activity-fields). |
178182

@@ -260,6 +264,19 @@ The `totals_by_cli` object contains the following nested fields when {% data var
260264
| `totals_by_cli.last_known_cli_version.cli_version` | `string` | No | {% data variables.copilot.copilot_cli_short %} version string. Defaults to `unknown` if no version was detected. |
261265
| `totals_by_cli.last_known_cli_version.sampled_at` | `string` | Yes | Timestamp (ISO 8601) when the version was sampled. |
262266

267+
### {% data variables.copilot.github_copilot_app_short %} metrics fields
268+
269+
The `totals_by_copilot_app` object contains the following nested fields when {% data variables.copilot.github_copilot_app_short %} usage is present. It appears in per-user reports and in aggregated enterprise reports; it is omitted or null when the user or enterprise had no {% data variables.copilot.github_copilot_app_short %} activity that day. Unlike `totals_by_cli`, {% data variables.copilot.github_copilot_app_short %} coding activity is also reflected in `totals_by_feature`, `totals_by_model_feature`, `totals_by_language_feature`, and `totals_by_language_model` under the `copilot_app` feature value, and in the top-level code activity and lines-of-code metrics. There is no `last_known_app_version` field.
270+
271+
| Field | Type | Nullable | Description |
272+
|:--|:--|:--|:--|
273+
| `totals_by_copilot_app.session_count` | `integer` | No | Number of distinct {% data variables.copilot.github_copilot_app_short %} sessions initiated on this day. |
274+
| `totals_by_copilot_app.request_count` | `integer` | No | Total number of requests made to {% data variables.product.prodname_copilot_short %} via the {% data variables.copilot.github_copilot_app_short %} on this day, including both user-initiated prompts and automated agentic follow-up calls. |
275+
| `totals_by_copilot_app.prompt_count` | `integer` | No | Total number of user prompts, commands, or queries executed within a session. |
276+
| `totals_by_copilot_app.token_usage.output_tokens_sum` | `integer` | No | Total output tokens generated across all {% data variables.copilot.github_copilot_app_short %} requests on this day. |
277+
| `totals_by_copilot_app.token_usage.prompt_tokens_sum` | `integer` | No | Total prompt tokens sent across all {% data variables.copilot.github_copilot_app_short %} requests on this day. |
278+
| `totals_by_copilot_app.token_usage.avg_tokens_per_request` | `number` | Yes | Average of output and prompt tokens per {% data variables.copilot.github_copilot_app_short %} request, computed as `(output_tokens_sum + prompt_tokens_sum) ÷ request_count`. Null when there were no requests that day. |
279+
263280
### Pull request activity fields
264281

265282
> [!IMPORTANT]
@@ -348,6 +365,7 @@ The `feature` dimension identifies the {% data variables.product.prodname_copilo
348365
| `chat_panel_unknown_mode` | Chat panel interactions where the mode is unknown. |
349366
| `agent_edit` | Lines added and deleted when {% data variables.product.prodname_copilot_short %} (in agent and edit mode) writes changes directly into your files in the IDE. Counts edits from custom agents as well. `agent_edit` is not included in suggestion-based metrics and may not populate suggestion-style fields, such as `user_initiated_interaction_count`. |
350367
| `copilot_cli` | Activity attributed to {% data variables.copilot.copilot_cli_short %}. |
368+
| `copilot_app` | Activity attributed to the {% data variables.product.prodname_copilot_short %} app. |
351369
| `others` | Any feature not covered by the values above. |
352370

353371
The `ide` dimension identifies the IDE an activity occurred in. This is not an exhaustive list, but examples of observed values include `vscode`, `visualstudio`, `intellij`, `eclipse`, `xcode`, `neovim`, `vim`, `emacs`, and `zed`.

content/copilot/reference/copilot-usage-metrics/example-schema.md

Lines changed: 97 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ The following are example schemas for the user-level, enterprise-level, and repo
2020
```json copy
2121
[{
2222
"ai_credits_used": 12.5,
23-
"code_acceptance_activity_count": 1,
24-
"code_generation_activity_count": 1,
23+
"code_acceptance_activity_count": 3,
24+
"code_generation_activity_count": 3,
2525
"day": "2025-10-01",
2626
"enterprise_id": "1",
27-
"loc_added_sum": 8,
28-
"loc_deleted_sum": 0,
29-
"loc_suggested_to_add_sum": 10,
30-
"loc_suggested_to_delete_sum": 0,
27+
"loc_added_sum": 32,
28+
"loc_deleted_sum": 6,
29+
"loc_suggested_to_add_sum": 34,
30+
"loc_suggested_to_delete_sum": 6,
3131
"totals_by_cli": {
3232
"last_known_cli_version": {
3333
"cli_version": "1.0.8",
@@ -42,6 +42,16 @@ The following are example schemas for the user-level, enterprise-level, and repo
4242
"prompt_tokens_sum": 3800
4343
}
4444
},
45+
"totals_by_copilot_app": {
46+
"prompt_count": 1,
47+
"request_count": 3,
48+
"session_count": 1,
49+
"token_usage": {
50+
"avg_tokens_per_request": 3200.0,
51+
"output_tokens_sum": 4200,
52+
"prompt_tokens_sum": 5400
53+
}
54+
},
4555
"totals_by_feature": [{
4656
"code_acceptance_activity_count": 1,
4757
"code_generation_activity_count": 1,
@@ -51,6 +61,15 @@ The following are example schemas for the user-level, enterprise-level, and repo
5161
"loc_suggested_to_add_sum": 10,
5262
"loc_suggested_to_delete_sum": 0,
5363
"user_initiated_interaction_count": 0
64+
}, {
65+
"code_acceptance_activity_count": 2,
66+
"code_generation_activity_count": 2,
67+
"feature": "copilot_app",
68+
"loc_added_sum": 24,
69+
"loc_deleted_sum": 6,
70+
"loc_suggested_to_add_sum": 24,
71+
"loc_suggested_to_delete_sum": 6,
72+
"user_initiated_interaction_count": 1
5473
}],
5574
"totals_by_ide": [{
5675
"code_acceptance_activity_count": 1,
@@ -80,15 +99,25 @@ The following are example schemas for the user-level, enterprise-level, and repo
8099
"loc_deleted_sum": 0,
81100
"loc_suggested_to_add_sum": 10,
82101
"loc_suggested_to_delete_sum": 0
102+
}, {
103+
"code_acceptance_activity_count": 2,
104+
"code_generation_activity_count": 2,
105+
"feature": "copilot_app",
106+
"language": "markdown",
107+
"loc_added_sum": 24,
108+
"loc_deleted_sum": 6,
109+
"loc_suggested_to_add_sum": 24,
110+
"loc_suggested_to_delete_sum": 6
83111
}],
84112
"totals_by_language_model": [],
85113
"totals_by_model_feature": [],
86114
"used_agent": false,
87115
"used_chat": false,
88116
"used_cli": true,
117+
"used_copilot_app": true,
89118
"user_id": 1,
90119
"user_login": "login1",
91-
"user_initiated_interaction_count": 0,
120+
"user_initiated_interaction_count": 1,
92121
"etl_id": "green",
93122
"day_partition": "2025-10-01",
94123
"entity_id_partition": 1
@@ -100,16 +129,17 @@ The following are example schemas for the user-level, enterprise-level, and repo
100129
```json copy
101130
[ {
102131
"day_totals" : [ {
103-
"code_acceptance_activity_count" : 2,
104-
"code_generation_activity_count" : 2,
132+
"code_acceptance_activity_count" : 4,
133+
"code_generation_activity_count" : 4,
105134
"daily_active_cli_users" : 2,
135+
"daily_active_copilot_app_users" : 1,
106136
"daily_active_users" : 2,
107137
"day" : "2025-10-01",
108138
"enterprise_id" : "1",
109-
"loc_added_sum" : 30,
110-
"loc_deleted_sum" : 0,
111-
"loc_suggested_to_add_sum" : 35,
112-
"loc_suggested_to_delete_sum" : 0,
139+
"loc_added_sum" : 54,
140+
"loc_deleted_sum" : 6,
141+
"loc_suggested_to_add_sum" : 59,
142+
"loc_suggested_to_delete_sum" : 6,
113143
"monthly_active_agent_users" : 0,
114144
"monthly_active_chat_users" : 0,
115145
"monthly_active_users" : 2,
@@ -139,6 +169,16 @@ The following are example schemas for the user-level, enterprise-level, and repo
139169
"prompt_tokens_sum" : 5300
140170
}
141171
},
172+
"totals_by_copilot_app" : {
173+
"prompt_count" : 2,
174+
"request_count" : 6,
175+
"session_count" : 2,
176+
"token_usage" : {
177+
"avg_tokens_per_request" : 2466.67,
178+
"output_tokens_sum" : 6200,
179+
"prompt_tokens_sum" : 8600
180+
}
181+
},
142182
"totals_by_feature" : [ {
143183
"code_acceptance_activity_count" : 2,
144184
"code_generation_activity_count" : 2,
@@ -148,6 +188,15 @@ The following are example schemas for the user-level, enterprise-level, and repo
148188
"loc_suggested_to_add_sum" : 35,
149189
"loc_suggested_to_delete_sum" : 0,
150190
"user_initiated_interaction_count" : 0
191+
}, {
192+
"code_acceptance_activity_count" : 2,
193+
"code_generation_activity_count" : 2,
194+
"feature" : "copilot_app",
195+
"loc_added_sum" : 24,
196+
"loc_deleted_sum" : 6,
197+
"loc_suggested_to_add_sum" : 24,
198+
"loc_suggested_to_delete_sum" : 6,
199+
"user_initiated_interaction_count" : 1
151200
} ],
152201
"totals_by_ide" : [ {
153202
"code_acceptance_activity_count" : 2,
@@ -168,10 +217,19 @@ The following are example schemas for the user-level, enterprise-level, and repo
168217
"loc_deleted_sum" : 0,
169218
"loc_suggested_to_add_sum" : 35,
170219
"loc_suggested_to_delete_sum" : 0
220+
}, {
221+
"code_acceptance_activity_count" : 2,
222+
"code_generation_activity_count" : 2,
223+
"feature" : "copilot_app",
224+
"language" : "markdown",
225+
"loc_added_sum" : 24,
226+
"loc_deleted_sum" : 6,
227+
"loc_suggested_to_add_sum" : 24,
228+
"loc_suggested_to_delete_sum" : 6
171229
} ],
172230
"totals_by_language_model" : [ ],
173231
"totals_by_model_feature" : [ ],
174-
"user_initiated_interaction_count" : 0,
232+
"user_initiated_interaction_count" : 1,
175233
"weekly_active_users" : 2
176234
} ],
177235
"enterprise_id" : "1",
@@ -182,15 +240,15 @@ The following are example schemas for the user-level, enterprise-level, and repo
182240
"entity_id_partition" : 1
183241
}, {
184242
"day_totals" : [ {
185-
"code_acceptance_activity_count" : 1,
186-
"code_generation_activity_count" : 2,
243+
"code_acceptance_activity_count" : 2,
244+
"code_generation_activity_count" : 3,
187245
"daily_active_users" : 2,
188246
"day" : "2025-10-01",
189247
"enterprise_id" : "2",
190-
"loc_added_sum" : 38,
191-
"loc_deleted_sum" : 0,
192-
"loc_suggested_to_add_sum" : 40,
193-
"loc_suggested_to_delete_sum" : 0,
248+
"loc_added_sum" : 50,
249+
"loc_deleted_sum" : 3,
250+
"loc_suggested_to_add_sum" : 52,
251+
"loc_suggested_to_delete_sum" : 3,
194252
"monthly_active_agent_users" : 0,
195253
"monthly_active_chat_users" : 0,
196254
"monthly_active_users" : 2,
@@ -216,6 +274,15 @@ The following are example schemas for the user-level, enterprise-level, and repo
216274
"loc_suggested_to_add_sum" : 40,
217275
"loc_suggested_to_delete_sum" : 0,
218276
"user_initiated_interaction_count" : 0
277+
}, {
278+
"code_acceptance_activity_count" : 1,
279+
"code_generation_activity_count" : 1,
280+
"feature" : "copilot_app",
281+
"loc_added_sum" : 12,
282+
"loc_deleted_sum" : 3,
283+
"loc_suggested_to_add_sum" : 12,
284+
"loc_suggested_to_delete_sum" : 3,
285+
"user_initiated_interaction_count" : 1
219286
} ],
220287
"totals_by_ide" : [ {
221288
"code_acceptance_activity_count" : 1,
@@ -236,10 +303,19 @@ The following are example schemas for the user-level, enterprise-level, and repo
236303
"loc_deleted_sum" : 0,
237304
"loc_suggested_to_add_sum" : 40,
238305
"loc_suggested_to_delete_sum" : 0
306+
}, {
307+
"code_acceptance_activity_count" : 1,
308+
"code_generation_activity_count" : 1,
309+
"feature" : "copilot_app",
310+
"language" : "markdown",
311+
"loc_added_sum" : 12,
312+
"loc_deleted_sum" : 3,
313+
"loc_suggested_to_add_sum" : 12,
314+
"loc_suggested_to_delete_sum" : 3
239315
} ],
240316
"totals_by_language_model" : [ ],
241317
"totals_by_model_feature" : [ ],
242-
"user_initiated_interaction_count" : 0,
318+
"user_initiated_interaction_count" : 1,
243319
"weekly_active_users" : 2
244320
} ],
245321
"enterprise_id" : "2",

data/variables/copilot.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ copilot_vsc_chat_participants: 'Copilot-enabled VS Code chat participants'
9797

9898
## GitHub Copilot app
9999
github_copilot_app: 'GitHub Copilot app'
100+
github_copilot_app_short: 'Copilot app'
100101

101102
## Copilot CLI
102103
copilot_cli_short: 'Copilot CLI'

0 commit comments

Comments
 (0)