enterprise/analytics-api.md +11 −8
2 2
3> For the complete documentation index, see [llms.txt](https://learn.chatgpt.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to the page URL.3> For the complete documentation index, see [llms.txt](https://learn.chatgpt.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to the page URL.
4 4
55The Codex Analytics API provides aggregated Codex usage and activity metrics forThe Analytics APIs provide aggregated usage and activity metrics for a ChatGPT
66a ChatGPT workspace.workspace. The unified Daily Usage Analytics API reports daily ChatGPT, Codex,
7and Work usage. Confirm that the endpoint is enabled for your workspace before
8using it.
7 9
810The [Codex Analytics API reference](https://chatgpt.com/public/admin/api-reference#tag/Codex%20Enterprise%20Analytics)The [Admin API reference](https://chatgpt.com/public/admin/api-reference)
9is the source of truth for current access requirements, routes, request and11is the source of truth for current access requirements, routes, request and
10response schemas, metrics, time semantics, and pagination.12response schemas, metrics, time semantics, and pagination.
11 13
13 15
14The Analytics API is appropriate when you need to:16The Analytics API is appropriate when you need to:
15 17
1618- Automate recurring Codex reporting.- Automate recurring workspace usage reporting.
1719- Join aggregated Codex metrics with internal organizational data.- Join aggregated usage metrics with internal organizational data.
18- Build a controlled reporting layer for approved audiences.20- Build a controlled reporting layer for approved audiences.
19- Avoid coupling an integration to an interactive dashboard.21- Avoid coupling an integration to an interactive dashboard.
20 22
24 26
25## Confirm the administration boundaries27## Confirm the administration boundaries
26 28
2729Analytics API results are scoped to a ChatGPT workspace, but requestsAnalytics API results are scoped to a ChatGPT workspace. For the unified Daily
2830authenticate with a Platform organization API key. The key's organization mustUsage Analytics API, use a workspace-scoped Admin key with
2931match the organization associated with the workspace.`enterprise.analytics.usage.read`. The Codex scope
32`codex.enterprise.analytics.read` doesn't grant access to that endpoint.
30 33
31The API reference owns current key provisioning, scope requirements,34The API reference owns current key provisioning, scope requirements,
32routes, schemas, fields, time semantics, and pagination behavior. This page35routes, schemas, fields, time semantics, and pagination behavior. This page