Skip to content

Add ai_credits_used and update API schema output #44994

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
imranmaszeri wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −11
Open

Add ai_credits_used and update API schema output #44994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d8c883
add ai_credits_used and update schema output
imranmaszeri Jun 30, 2026
7afd431
Potential fix for pull request finding
Sharra-writes Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/copilot/reference/copilot-usage-metrics/copilot-usage-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Per-user reports contain one record per user for the reporting period. The 28-da
| `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. |
| `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. |
| `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). |
| `ai_credits_used` | `number` | No | Total {% data variables.product.prodname_ai_credits_short %} consumed by the user on this day. |
| `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). |
| `totals_by_ide` | `array` | No | Per-IDE breakdown of the user's activity. See [Activity breakdown objects](#activity-breakdown-objects). |
| `totals_by_feature` | `array` | No | Per-feature breakdown of the user's activity. See [Activity breakdown objects](#activity-breakdown-objects). |
Expand Down
21 changes: 10 additions & 11 deletions content/copilot/reference/copilot-usage-metrics/example-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,17 @@ The following are example schemas for the user-level and enterprise-level data r
"used_agent": false,
"used_chat": false,
"used_cli": true,
"used_copilot_coding_agent": false,
"used_copilot_cloud_agent": false,
"ai_adoption_phase": {
"phase_number": 2,
"phase": "Phase 2",
"version": "v1"
},
"user_id": 1,
"user_login": "login1",
"user_initiated_interaction_count": 0,
"etl_id": "green",
"day_partition": "2025-10-01",
"entity_id_partition": 1
"ai_credits_used": 500
}]
```

Expand Down Expand Up @@ -175,10 +180,7 @@ The following are example schemas for the user-level and enterprise-level data r
} ],
"enterprise_id" : "1",
"report_end_day" : "2025-10-01",
"report_start_day" : "2025-09-04",
"etl_id" : "green",
"day_partition" : "2025-10-01",
"entity_id_partition" : 1
"report_start_day" : "2025-09-04"
}, {
"day_totals" : [ {
"code_acceptance_activity_count" : 1,
Expand Down Expand Up @@ -243,10 +245,7 @@ The following are example schemas for the user-level and enterprise-level data r
} ],
"enterprise_id" : "2",
"report_end_day" : "2025-10-01",
"report_start_day" : "2025-09-04",
"etl_id" : "green",
"day_partition" : "2025-10-01",
"entity_id_partition" : 2
"report_start_day" : "2025-09-04"
} ]
```

Expand Down
Loading