分析 API
如需完整文档索引,请参阅 llms.txt。文档页面的 Markdown 版本可通过在页面后追加
.md来获取 URL。
该 Codex Analytics API 提供聚合的 Codex 使用情况和活动指标,用于 一个 ChatGPT 工作区。
经身份验证的 Codex Analytics API 参考文档 是当前访问要求、路由、请求和 响应架构、指标、时间语义和分页的权威来源。
何时使用 Analytics API
Section titled “何时使用 Analytics API”在以下情况下,Analytics API 适用:
- 自动化定期 Codex 报告。
- 将汇总的 Codex 指标与内部组织数据关联。
- 为获批准的受众构建受控报告层。
- 避免让集成依赖交互式仪表板。
它不是原始审计日志接口。当工作流需要 Compliance API 时,请使用 可审计的活动记录。
确认管理边界
Section titled “确认管理边界”Analytics API 结果限定在一个 ChatGPT 工作区内,但请求 使用 Platform 组织 API 密钥进行身份验证。该密钥的组织必须 与工作区关联的组织匹配。
经身份验证的参考文档负责说明当前密钥配置、范围要求、 路由、架构、字段、时间语义和分页行为。此页面 不会重复该约定。