You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md
+21-3Lines changed: 21 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -120,12 +120,14 @@ Per-user reports contain one record per user for the reporting period. The 28-da
120
120
|`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`. |
121
121
|`used_chat`|`boolean`| No | Whether the user used IDE chat that day. |
122
122
|`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. |
123
124
|`used_copilot_coding_agent`|`boolean`| No | Whether the user used {% data variables.copilot.copilot_cloud_agent %} (previously Copilot coding agent) that day. |
124
125
|`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. |
125
126
|`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. |
126
127
|`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. |
127
128
|`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). |
128
129
|`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). |
129
131
|`totals_by_ide`|`array`| No | Per-IDE breakdown of the user's activity. See [Activity breakdown objects](#activity-breakdown-objects). |
130
132
|`totals_by_feature`|`array`| No | Per-feature breakdown of the user's activity. See [Activity breakdown objects](#activity-breakdown-objects). |
131
133
|`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:
140
142
141
143
| Field | Type | Nullable | Description |
142
144
|:--|:--|:--|:--|
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 %}. |
146
148
|`monthly_active_chat_users`|`integer`| No | Number of unique users who used chat during a trailing 28-day window. |
147
149
|`monthly_active_agent_users`|`integer`| No | Number of unique users who used agent mode during a trailing 28-day window. |
148
150
|`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:
155
157
|`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. |
156
158
|`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. |
157
159
|`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. |
158
161
159
162
Activity totals and breakdowns:
160
163
@@ -173,6 +176,7 @@ Activity totals and breakdowns:
173
176
|`totals_by_language_model`|`array`| No | Aggregated language-and-model activity breakdown. See [Activity breakdown objects](#activity-breakdown-objects). |
174
177
|`totals_by_model_feature`|`array`| No | Aggregated model-and-feature activity breakdown. See [Activity breakdown objects](#activity-breakdown-objects). |
175
178
|`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). |
176
180
|`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). |
177
181
|`pull_requests`|`object`| No | Daily pull request activity for the enterprise or organization. See [Pull request activity fields](#pull-request-activity-fields). |
178
182
@@ -260,6 +264,19 @@ The `totals_by_cli` object contains the following nested fields when {% data var
260
264
|`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. |
261
265
|`totals_by_cli.last_known_cli_version.sampled_at`|`string`| Yes | Timestamp (ISO 8601) when the version was sampled. |
262
266
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
+
263
280
### Pull request activity fields
264
281
265
282
> [!IMPORTANT]
@@ -348,6 +365,7 @@ The `feature` dimension identifies the {% data variables.product.prodname_copilo
348
365
|`chat_panel_unknown_mode`| Chat panel interactions where the mode is unknown. |
349
366
|`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`. |
350
367
|`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. |
351
369
|`others`| Any feature not covered by the values above. |
352
370
353
371
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`.
0 commit comments