メインコンテンツへスキップ
GET
/
api
/
v2alpha
/
analytics
/
consumption
消費量分析を取得する
curl --request GET \
  --url https://server.codeium.com/api/v2alpha/analytics/consumption \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "timestamp": "2026-01-15T00:00:00.000Z",
      "user_id": "user_abc123",
      "user_email": "alice@example.com",
      "consumption": {
        "prompt_credits": 1250,
        "flex_credits": 340,
        "message_count": 87
      }
    },
    {
      "timestamp": "2026-01-15T00:00:00.000Z",
      "user_id": "user_def456",
      "user_email": "bob@example.com",
      "consumption": {
        "prompt_credits": 980,
        "flex_credits": 150,
        "message_count": 52
      }
    }
  ],
  "pagination": {
    "next_page_cursor": null
  },
  "metadata": {
    "billing_strategy": "CREDITS",
    "data_freshness": "2026-01-16T03:00:00.000Z",
    "query_time_ms": 1423,
    "team_id": "team_abc123"
  }
}
これはv2 エンドポイントで、リクエストボディでサービスキーを使用する v1 Analytics API とは異なり、Bearerトークン認証とクエリパラメータを使用します。詳細は以下のAuthenticationを参照してください。
このエンドポイントはリアルタイムの使用量監視向けではありません。データは1時間単位で集計され、 レート制限も低く設定されています (チームごとに1時間あたり10リクエスト) 。定期レポートや一括エクスポートに利用してください。

​
認証

このエンドポイントでは、Bearer token認証を利用します。Authorization ヘッダーにサービスキーを含めてください。 
Authorization: Bearer <your_service_key>
サービスキーには、Analytics Read 権限が付与されている必要があります。チーム設定 の “Service Keys” で作成してください。

​
請求方式

レスポンスの形式は、チームの請求方式によって異なります。
戦略値が設定されるフィールド説明
CREDITSprompt_credits, flex_credits標準的な Enterprise SaaS チーム
ACUbilled_acusAgent Compute Units で課金されるチーム
message_count フィールド (consumption 内) は、請求方式に関係なく常に設定されます。

​
グループ化と粒度

granularity と group_by を利用して、返されるデータの形式を制御できます。
  • 粒度やグループ化の指定なし — 日付範囲全体を集計した単一の行を返します
  • granularity=daily — 各行に YYYY-MM-DD 形式の timestamp が含まれます
  • granularity=monthly — 各行に YYYY-MM 形式の timestamp が含まれます
  • group_by=user — 各行に user_id と user_email が含まれます
  • group_by=user,model_uid — 各行に user_id、user_email、model_uid が含まれます
  • group_by=ide — 各行に ide が含まれます
結果は、デフォルトで 1,000 行 (最大 10,000 行) ごとにページ分割されます。さらに結果がある場合、レスポンスの pagination オブジェクトには next_page_cursor が含まれます。次のページを取得するには、これを page_cursor クエリ パラメータとして渡します。 ページカーソルは 24 時間で失効します。後続のページリクエストは、レート制限に対する新たなクエリとしてはカウントされません。

​
キャッシュ

レスポンスには ETag ヘッダーが含まれます。不要なデータ転送を避けるには、以前の ETag 値を指定した If-None-Match ヘッダーを含めてください。データが変更されていない場合、サーバーは 304 Not Modified を返します。

​
レート制限

このエンドポイントには、チームごとに1時間あたり10リクエストのレート制限があります。この 制限を超えると、サーバーは Retry-After ヘッダーとともに 429 Too Many Requests を返します。 前にクエリした結果のページネーション (next_page_cursor に従うこと) は、この制限にはカウントされません— カウントされるのは、各レポートに対して初回にクエリする場合のみです。制限値が低く設定されているのは、このエンドポイントが 定期的なレポート用であり、リアルタイムの使用量監視を目的としたものではないためです。

承認

​
Authorization
string
header
必須

Authorization ヘッダーで Bearer トークンとして渡す、Analytics Read 権限を持つサービスキー。

サービスキーは、チーム設定 の「Service Keys」セクションで作成します。

ヘッダー

​
If-None-Match
string

以前のレスポンスの ETag 値。データが変更されていない場合、サーバーは 304 Not Modified を返します。

クエリパラメータ

​
start_date
string<date>
必須

日付範囲の開始日（この日を含む）。形式は YYYY-MM-DD です。

​
end_date
string<date>
必須

日付範囲の終了日（この日を含む）。形式は YYYY-MM-DD です。範囲は 90 日を超えてはいけません。

​
product
enum<string>
必須

消費量をクエリする対象の product。

利用可能なオプション:
agent
​
granularity
enum<string>

結果をグループ化する時間粒度。指定した場合、各行に timestamp フィールドが含まれます。 省略した場合、結果は日付範囲全体で集計されます。

利用可能なオプション:
daily,
monthly
​
group_by
string

結果のグループ化に使用するディメンションのカンマ区切りリスト。対応するディメンション:

  • user — 各行に user_id と user_email が含まれます
  • model_uid — 各行に model_uid が含まれます
  • ide — 各行に ide が含まれます
​
models
string

結果の絞り込み対象とする model UID のカンマ区切りリスト。

​
group_id
string

結果を特定の group に属する user に絞り込みます。サービスキーにはこの group へのアクセス権が必要です。

​
user_id
string

結果を特定の user（auth UID）に絞り込みます。

​
page_size
integer
デフォルト:1000

1 ページあたりに返す最大行数。

必須範囲: 1 <= x <= 10000
​
page_cursor
string

次のページを取得するための、以前のレスポンスの pagination.next_page_cursor に含まれる不透明なカーソル。

レスポンス

消費量データが正常に返されました。

​
data
object[]
必須

消費量データ行の配列。

​
pagination
object
必須
​
metadata
object
必須