分析 API では、ChatGPT ワークスペースの利用状況やアクティビティを集計した指標を取得できます。統合版の Daily Usage Analytics API では、ChatGPT、Codex、Work の利用状況を日別に取得できます。利用する前に、対象のワークスペースでこのエンドポイントが有効になっていることを確認してください。
アクセス要件、ルート、リクエストとレスポンスのスキーマ、指標、日時の扱い、ページネーションの最新仕様は、Admin API リファレンスで確認してください。
分析 API の用途
分析 API は、次のような用途に適しています。
- ワークスペースの利用状況に関する定期レポートの作成を自動化する
- 集計済みの利用指標を組織内のデータと結合する
- 閲覧を許可された利用者にレポートを提供できるよう、アクセス制御を備えた仕組みを構築する
- ダッシュボードの対話操作に依存せずにシステムを連携させる
分析 API では、監査ログの生データは取得できません。ワークフローで監査可能なアクティビティ記録が必要な場合は、Compliance API を使用してください。
対象ワークスペースとアクセス権限の確認
分析 API が返す結果は、対象の ChatGPT ワークスペースに限定されます。統合版の Daily Usage Analytics API には、対象のワークスペースに限定された管理者キーを使用してください。キーには enterprise.analytics.usage.read スコープが必要です。Codex 用の codex.enterprise.analytics.read スコープでは、このエンドポイントへのアクセス権は付与されません。
キーの発行方法、必要なスコープ、ルート、スキーマ、フィールド、日時の扱い、ページネーションの動作については、API リファレンスに最新の仕様が記載されています。このページでは、それらの仕様の再掲は省略しています。