enterprise/governance.md +43 −31
14 14
15## Analytics Dashboard15## Analytics Dashboard
16 16
1717<div class="max-w-1xl mx-auto">
18 <img src="https://developers.openai.com/images/codex/enterprise/analytics-dashboard.png"
19 alt="Codex analytics dashboard"
20 class="block w-full mx-auto rounded-lg !border-0"
21 />
22</div>
18 23
1924### Dashboards### Dashboard views
20 25
2126The [analytics dashboard](https://chatgpt.com/codex/settings/analytics) allows ChatGPT workspace administrators to track feature adoption.The [analytics dashboard](https://chatgpt.com/codex/cloud/settings/analytics#usage) allows ChatGPT workspace administrators and analytics viewers to track Codex adoption, usage, and Code Review feedback. Usage data can lag by up to 12 hours.
22 27
2328Codex provides the following dashboards:Codex provides date-range controls for daily and weekly views. Key charts include:
24 29
2530- Daily users by product (CLI, IDE, cloud, Code Review)- Active users by product surface, including CLI, IDE extension, cloud, desktop, and Code Review
2631- Daily code review users- Workspace and personal usage breakdowns, including credit and token usage by product surface
2732- Daily code reviews- Product activity for threads and turns by client
2833- Code reviews by priority level- User ranking table, with filters for client and sort options such as credits, threads, turns, text tokens, and current streak
2934- Daily code reviews by feedback sentiment- Code Review activity, including PRs reviewed, issues by priority, comments, replies, reactions, and feedback sentiment
3035- Daily cloud tasks- Skill invocations, agent identity usage, and access token usage when your workspace has those features
31- Daily cloud users
32- Daily VS Code extension users
33- Daily CLI users
34 36
35### Data export37### Data export
36 38
37Administrators can also export Codex analytics data in CSV or JSON format. Codex provides the following export options:39Administrators can also export Codex analytics data in CSV or JSON format. Codex provides the following export options:
38 40
3941- Code review users and reviews (Daily unique users and total reviews completed in Code Review)- Workspace usage, including daily active users, threads, turns, and credits by surface
4042- Code review findings and feedback (Daily counts of comments, reactions, replies, and priority-level findings)- Usage per user, including daily threads, turns, and credits across surfaces, with optional email addresses when allowed
4143- cloud users and tasks (daily unique cloud users and tasks completed)- Code Review details, including daily comments, reactions, replies, and priority-level findings
42- CLI and VS Code users (Daily unique users for the Codex CLI and VS Code extension)
43- Sessions and messages per user (Daily session starts and user message counts for each Codex user across surfaces)
44 44
45## Analytics API45## Analytics API
46 46
4747Use the [Analytics API](https://chatgpt.com/codex/settings/apireference) when you want to automate reporting, build internal dashboards, or join Codex metrics with your existing engineering data.Use the [Analytics API](https://chatgpt.com/codex/cloud/settings/apireference) when you want to automate reporting, build internal dashboards, or join Codex metrics with your existing engineering data.
48 48
49### What it measures49### What it measures
50 50
5151The Analytics API provides daily, time-series metrics for a workspace, with optional per-user breakdowns and per-client usage.The enterprise Analytics API returns daily or weekly UTC buckets for a workspace. It supports workspace-level and per-user usage, per-client breakdowns, Code Review throughput, Code Review comment priority, and user engagement with Code Review comments.
52 52
53### Endpoints53### Endpoints
54 54
5555#### Daily usage and adoptionThe base URL is `https://api.chatgpt.com/v1/analytics/codex`. All endpoints return paginated `page` objects with `has_more` and `next_page`.
56 56
5757- Daily totals for threads, turns, and creditsUse `start_time` for the inclusive Unix timestamp at the beginning of the reporting window, `end_time` for the exclusive Unix timestamp at the end of the reporting window, `group_by` for `day` or `week` buckets, `limit` for page size, and `page` to continue from a previous response. Requests can look back up to 90 days.
5858- Breakdown by client surface
5959- Optional per-user reporting for adoption and power-user analysis#### Usage
60
61`GET /workspaces/{workspace_id}/usage`
62
63- Returns totals for threads, turns, credits, and per-client usage in daily or weekly buckets.
64- Omit `group` to return per-user rows.
65- Set `group=workspace` to return workspace-wide rows.
66- Includes text input, cached input, and output token fields.
60 67
61#### Code review activity68#### Code review activity
62 69
6370- Pull request reviews completed by Codex`GET /workspaces/{workspace_id}/code_reviews`
6471- Total comments generated by Codex
6572- Severity breakdown of comments- Returns pull request reviews completed by Codex.
73- Returns total comments generated by Codex.
74- Breaks comments down by P0, P1, and P2 priority.
66 75
67#### User engagement with code review76#### User engagement with code review
68 77
6978- Replies to Codex comments`GET /workspaces/{workspace_id}/code_review_responses`
7079- Reactions, including upvotes and downvotes
7180- Engagement breakdowns for how teams respond to Codex feedback- Returns replies and reactions to Codex comments.
81- Breaks reactions down into positive, negative, and other reactions.
82- Counts comments that received reactions, replies, or either form of engagement.
72 83
73### How it works84### How it works
74 85
7586Analytics is daily and time-windowed. Results are time-ordered and returned in pages with cursor-based pagination. You can query by workspace and optionally group by user or aggregate at the workspace level.Analytics uses time windows and supports day or week grouping. Results are time-ordered and returned in pages with cursor-based pagination. Use an API key scoped to `codex.enterprise.analytics.read`.
76 87
77### Common use cases88### Common use cases
78 89
104Use record metadata to answer questions like:115Use record metadata to answer questions like:
105 116
106- Who ran a task117- Who ran a task
118- Who created or revoked an access token
107- When it ran119- When it ran
108- Which model was used120- Which model was used
109- How much content was processed121- How much content was processed